EvaluateShippingRulesCommand
The order attributes to evaluate shipping rules against. Describes a hypothetical order - nothing
is created, and no existing order is read or changed.
| Name | Description | Type | Additional information |
|---|
| ChannelID |
The Channel the order would arrive on. Rules can be pinned to a channel, and a rule pinned to
one scores higher than a rule that applies to all channels.
|
integer
|
None.
|
| ChannelShippingMethod |
The shipping method text supplied by the Channel, matched against a rule's channel shipping method.
|
string
|
None.
|
| OrderTotal |
|
decimal number
|
None.
|
| OrderSubtotal |
|
decimal number
|
None.
|
| OrderWeight |
|
decimal number
|
None.
|
| OrderShippingCost |
What the customer paid for shipping.
|
decimal number
|
None.
|
| PackagingID |
|
integer
|
None.
|
| HazardousMaterials |
True if any line is a hazardous product.
|
boolean
|
None.
|
| IsFragile |
True if any line is a fragile product.
|
boolean
|
None.
|
| ContainsBladedItems |
True if any line is a bladed product.
|
boolean
|
None.
|
| ShippingCountryID |
|
integer
|
None.
|
| ShippingState |
The destination state and postcode as text. Both are resolved to their internal IDs the same way
the import does, so a caller does not have to know those IDs.
|
string
|
None.
|
| ShippingZip |
|
string
|
None.
|
| CurrencyID |
|
integer
|
None.
|
| IsPriority |
|
boolean
|
None.
|
| IsPrime |
|
boolean
|
None.
|
| IsAmazonBusiness |
|
boolean
|
None.
|
| OrderLineCount |
Lines excluding kit components, matching what the import counts.
|
integer
|
None.
|
| WarehouseID |
|
integer
|
None.
|
| IossNumber |
|
string
|
None.
|
| EvaluateAt |
The moment to evaluate at, in the account's time zone. Rules can be pinned to a day of the week
and a courier cut-off time, so an evaluation is only reproducible if the caller can pin this.
Defaults to now in the account's time zone.
|
date
|
None.
|
