| Name | Description | Type | Additional information |
|---|---|---|---|
| ShipmentId |
The number that identifies the shipment. |
integer |
Required |
| Pickup |
The pickup information. |
Pickup |
Required |
| Delivery |
The delivery information. |
Delivery |
Required |
| TotalWeight |
The total weight of the shipment. The default UOM is kg (kilogram). |
decimal number |
Required |
| TotalWeightUOM |
The unit of measurement for the total weight. The default UOM is kg (kilogram). |
string |
None. |
| TotalVolume |
The total volume of the shipment. The default UOM is m3 (cubic metre). |
decimal number |
None. |
| TotalVolumeUOM |
The unit of measurement for the total volume. The default UOM is m3 (cubic metre). |
string |
None. |
| LoadingLength |
The loading length of the shipment. The default UOM is m (metre). |
decimal number |
None. |
| LoadingLengthUOM |
The unit of measurement for the loading length. The default UOM is m (metre). |
string |
None. |
| PackageCount |
The number of packages of the shipment. |
integer |
Required |
| Packages |
The list of packages of the shipment. |
Collection of Package |
None. |
| RequestedTransitTime |
The requested transit time (in days). 0 means "same day delivery". Do NOT set this value to look for freight rates of any transit time. |
integer |
None. |
| RequestedTransitTimeOperator |
The requested transit time operator. If NOT set, then the default value is "<=". |
string |
None. |
| EstimateDeliveryDateFirst |
Indicates if the delivery date should be estimated before the pickup date. If FALSE, then the pickup date is estimated and the transit time is added to estimate the delivery date. If TRUE, then the delivery date is estimated and the transit time is subtracted to estimate the pickup date. If NOT set, then the default value is FALSE. |
boolean |
None. |
| DgClasses |
The list of dangerous goods classes of the shipment. |
Collection of string |
None. |
| UnNumbers |
The list of UN numbers of the shipment. |
Collection of string |
None. |
| OptionCodes |
The list of option codes of the shipment. These are used to determine which surcharges are applicable. |
Collection of string |
None. |
| MoreInfo |
More information about the shipment. |
MoreShipmentInfo |
None. |