Exigo Web Service

CalculateOrder
Calculates the details of an order and returns ship methods.

CSV Support
No
Transactional Support
No
CalculateOrderRequest
CurrencyCode [Required]
String
Yes
The standard ISO 4217 3-letter currency code
WarehouseID [Required]
Int32
Yes
The unique identifier for the warehouse
ShipMethodID [Required]
Int32
Yes
The unique identifier for the ship method
PriceType [Required]
Int32
Yes
The type of price
Address1
String
No
The shipping address' street address. Used to calculate shipping and taxes.
City [Required]
String
Yes
The shipping address' city. Used to calculate shipping and taxes.
State [Required]
String
Yes
The shipping address' state or region code. Used to calculate shipping and taxes.
Zip [Required]
String
Yes
The shipping address' zip code. Used to calculate shipping and taxes.
Country [Required]
String
Yes
The shipping address' country code. Used to calculate shipping and taxes.
County
String
No
The shipping address' county. Can be used to calculate shipping and taxes.
CustomerID
Int32
No
The unique identifier of the customer
OrderType
OrderType
No
The type of order. OrderType should be defined if you have custom order calculation rules associated with certain order types.
Details [Required]
OrderDetailRequest[]
Yes
The items in the order
ReturnShipMethods [Required]
Boolean
Yes
Specifies whether to return ship methods. Defaults to false.
OrderDetailRequest
ItemCode [Required]
String
Yes
The alphanumeric unique identifier for the item
Quantity [Required]
Decimal
Yes
The quantity of the item
ParentItemCode
String
No
The kit's master item code. If this is defined, this item will be considered a part of a kit and it's price will not be used when calculating it into the order.
PriceEachOverride
Decimal?
No
The overridden price per item. Defining this will override the default value set in Exigo.
TaxableEachOverride
Decimal?
No
The overridden taxable amount per item. Defining this will override the default value set in Exigo.
ShippingPriceEachOverride
Decimal?
No
The overridden shipping amount per item. Defining this will override the default value set in Exigo.
BusinessVolumeEachOverride
Decimal?
No
The overridden BV amount earned per item. Defining this will override the default value set in Exigo.
CommissionableVolumeEachOverride
Decimal?
No
The overridden CV amount earned per item. Defining this will override the default value set in Exigo.
Other1EachOverride
Decimal?
No
The overridden custom Other1 amount per item. Defining this will override the default value set in Exigo.
Other2EachOverride
Decimal?
No
The overridden custom Other2 amount per item. Defining this will override the default value set in Exigo.
Other3EachOverride
Decimal?
No
The overridden custom Other3 amount per item. Defining this will override the default value set in Exigo.
Other4EachOverride
Decimal?
No
The overridden custom Other4 amount per item. Defining this will override the default value set in Exigo.
Other5EachOverride
Decimal?
No
The overridden custom Other5 amount per item. Defining this will override the default value set in Exigo.
Other6EachOverride
Decimal?
No
The overridden custom Other6 amount per item. Defining this will override the default value set in Exigo.
Other7EachOverride
Decimal?
No
The overridden custom Other7 amount per item. Defining this will override the default value set in Exigo.
Other8EachOverride
Decimal?
No
The overridden custom Other8 amount per item. Defining this will override the default value set in Exigo.
Other9EachOverride
Decimal?
No
The overridden custom Other9 amount per item. Defining this will override the default value set in Exigo.
Other10EachOverride
Decimal?
No
The overridden custom Other10 amount per item. Defining this will override the default value set in Exigo.
DescriptionOverride
String
No
The overridden item description. Defining this will override the default value set in Exigo.
CalculateOrderResponse
Total
Decimal
The total of the order
SubTotal
Decimal
The subtotal of the order
TaxTotal
Decimal
The total taxes of the order
ShippingTotal
Decimal
The total shipping fees of the order
DiscountTotal
Decimal
The total discounts applied to the order
DiscountPercent
Decimal
WeightTotal
Decimal
The total weight of the item
BusinessVolumeTotal
Decimal
The total business volume of the order
CommissionableVolumeTotal
Decimal
The total commissionable volume of the order
Other1Total
Decimal
The total value of the Other1 price of the order
Other2Total
Decimal
The total value of the Other2 price of the order
Other3Total
Decimal
The total value of the Other3 price of the order
Other4Total
Decimal
The total value of the Other4 price of the order
Other5Total
Decimal
The total value of the Other5 price of the order
Other6Total
Decimal
The total value of the Other6 price of the order
Other7Total
Decimal
The total value of the Other7 price of the order
Other8Total
Decimal
The total value of the Other8 price of the order
Other9Total
Decimal
The total value of the Other9 price of the order
Other10Total
Decimal
The total value of the Other10 price of the order
ShippingTax
Decimal
The total tax from shipping of the order
OrderTax
Decimal
FedTaxTotal
Decimal
StateTaxTotal
Decimal
Details [Required]
OrderDetailResponse[]
The items in the order
ShipMethods
ShipMethodResponse[]
Warnings
String[]
Result
ApiResult
The status of your web service call response. This property tells you if the call was executed successfully, any errors that occurred and other miscellanous, method-specific information.
OrderDetailResponse
ItemCode
String
The alphanumeric unique identifier for the item
Description
String
Quantity
Decimal
The quantity of the item
PriceEach
Decimal
The price of each item
PriceTotal
Decimal
The total amount for this item, based on the price of the item and the quantity selected
Tax
Decimal
The tax charged for the item
WeightEach
Decimal
The weight of each item
Weight
Decimal
The weight of the items, based on the quantity selected
BusinessVolumeEach
Decimal
The BV earned for each item
BusinesVolume
Decimal
The BV earned for the item, based on the quantity selected
CommissionableVolumeEach
Decimal
The CV earned for each item
CommissionableVolume
Decimal
The CV earned for the item, based on the quantity selected
Other1Each
Decimal
A company-defined custom price amount per item.
Other1
Decimal
A company-defined custom price total.
Other2Each
Decimal
A company-defined custom price amount per item.
Other2
Decimal
A company-defined custom price total.
Other3Each
Decimal
A company-defined custom price amount per item.
Other3
Decimal
A company-defined custom price total.
Other4Each
Decimal
A company-defined custom price amount per item.
Other4
Decimal
A company-defined custom price total.
Other5Each
Decimal
A company-defined custom price amount per item.
Other5
Decimal
A company-defined custom price total.
Other6Each
Decimal
A company-defined custom price amount per item.
Other6
Decimal
A company-defined custom price total.
Other7Each
Decimal
A company-defined custom price amount per item.
Other7
Decimal
A company-defined custom price total.
Other8Each
Decimal
A company-defined custom price amount per item.
Other8
Decimal
A company-defined custom price total.
Other9Each
Decimal
A company-defined custom price amount per item.
Other9
Decimal
A company-defined custom price total.
Other10Each
Decimal
A company-defined custom price amount per item.
Other10
Decimal
A company-defined custom price total.
ParentItemCode
String
The kit's master item code. If this is defined, this item will be considered a part of a kit and it's price will not be used when calculating it into the order.
Taxable
Decimal
Specifies whether the item is taxable
FedTax
Decimal
The federal tax charged for the item
StateTax
Decimal
The state tax charged for the item
CityTax
Decimal
The city tax charged for the item
CityLocalTax
Decimal
The cities' local tax charged for the item
CountyTax
Decimal
The county tax charged for the item
CountyLocalTax
Decimal
The counties' local tax charged for the item
ManualTax
Decimal
The manually-added tax charged for the item
IsStateTaxOverride
Boolean
Specifies whether the state tax was overridden for the item
OrderLine
Int32
The 0-based index position of the item in the order's detail collection
ShipMethodResponse
ShipMethodID
Int32
The unique identifier for the ship method
Description
String
ShippingAmount
Decimal
The calculated amount added to the order if this ship method is used
ApiResult
Status
ResultStatus
Specifies whether the web service call was successfully executed.
Errors
String[]
An array of error messages that were returned from Exigo. If the web service call was successful, this colleciton will be empty.
TransactionKey
String
The unique GUID identifier assigned to this web service call for logging purposes.

C# Sample

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
var request = new CalculateOrderRequest();
 
request.CurrencyCode      = "";
request.WarehouseID       = 1;
request.ShipMethodID      = 1;
request.PriceType         = 1;
request.ReturnShipMethods = true;
 
request.City              = "";
request.State             = "";
request.Zip               = "";
request.Country           = "";
 
request.Details           = new OrderDetailRequest[0];
 
var response = context.CalculateOrder(request);