| Name | Description | Type | Additional information |
|---|---|---|---|
| ShippingNotes |
Optional. Free-text shipping notes. Trimmed; maximum 1000 characters (validated on the trimmed value). |
string |
Optional. Trimmed; maximum 1000 characters.
|
| NonStackable |
Optional. Defaults to false. When true, applies non-stackable to all items on this request (OR'd with each item's own NonStackable). Omitting or false leaves item-level behavior unchanged. |
boolean |
Optional. Defaults to false. When true
applies to all items. |
| ConsigneeAddress |
Consignee address |
RateAddressV3 |
Required
|
| SoldToAddress |
Sold-to address. Optional. Currently only the TaxIDNumber is consumed (writable input only — does not affect rates response). |
RateAddressV3 |
Optional. Only TaxIDNumber is consumed.
|
| Carriers |
Provide carrier details to get rates for specific carriers. Rates for all carriers will be fetched if left empty. |
Collection of Carrier |
Optional
|
| CarrierType |
If CarrierType is passed then system will pick some carriers automatically get rates. CarrierType should only be passed if list of carriers is not passed. If list of carriers is passed then we will ignore this. If you want to get the rates of Truckload and Ocean Freight then you don't need to pass this and mention it in the PackageType of the first item of Shipment Items detail |
CarrierType |
Optional
|
| CustomerId |
Company ID for customers when Logistics Provider flag is turned on. Otherwise it will be ignored. |
string |
None. |
| Items |
Shipment Items detail |
Collection of ItemV4 |
Required
|
| ShipDate |
Ship date in UTC |
date |
Optional
|
| ShipperAddress |
Shipper address |
RateAddressV3 |
Required
|
| AdditionalDetails |
Additional details |
AdditionalDetailsV4 |
Optional
|
| ProductDetails |
Product details |
Collection of ProductDetail |
None. |
| ITN |
International transaction number |
string |
None. |
| PickupDetails |
Pickup details |
PickupDetails |
Optional
|
| RoutingGuideRuleHistoryId |
RoutingGuideRuleHistoryId needs to be provided if PackageRules API was called to get the shipment details. |
integer |
Optional
|