| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomsStatus |
Indicates the customs status of the shipment. This is used to determine which surcharges are applicable. If NOT set, then the default value is "" (the shipment has no customs status). |
string |
None. |
| ExtraStopCount |
This is used to calculate surcharges based on the number of extra stops required to pickup/deliver a shipment. |
integer |
None. |
| ExtraPickupStopCount |
This is used to calculate surcharges based on the number of extra stops required to pickup a shipment. |
integer |
None. |
| ExtraDeliveryStopCount |
This is used to calculate surcharges based on the number of extra stops required to deliver a shipment. |
integer |
None. |
| GoodsClassificationCode |
The code of the shipment's goods classification ("NONE", "SENSITIVE" or "DANGEROUS"). This is used to determine if the shipment is restricted. |
string |
None. |
| HasCustomsDocuments |
Indicates if the shipment has customs documents. This is used to determine which surcharges are applicable. If NOT set, then the default value is FALSE (the shipment has no customs documents). |
boolean |
None. |
| HasDangerousGoods |
Indicates if the shipment has dangerous goods. This is used to determine which surcharges are applicable. If NOT set, then the default value is FALSE (the shipment has no dangerous goods). |
boolean |
None. |
| InboundOutbound3rdParty |
Indicates if the shipment is "INBOUND", "OUTBOUND" or "3RDPARTY". This is used to determine which surcharges are applicable. If NOT set, then surcharges that specify an INCOTERM duty will not be applicable. INCOTERM duties include "load to truck", "transport to destination", "insurance", etc. INCOTERM rules determine which surcharges are applicable, depending on the INCOTERM code of the freight rate, the INCOTERM duty of the surcharge and the INBOUND/OUTBOUND/3RDPARTY value of the shipment. |
string |
None. |
| PortOfDischarge |
The code of the port of discharge. Use only alphanumeric characters (A-Z, 0-9). Do NOT use spaces or any other characters. If set, it will be used instead of the delivery postal code when determining which surcharges are applicable (this is an old workaround). In the future we should support both postal codes and ports. |
string |
None. |
| PortOfLoading |
The code of the port of loading. Use only alphanumeric characters (A-Z, 0-9). Do NOT use spaces or any other characters. If set, it will be used instead of the pickup postal code when determining which surcharges are applicable (this is an old workaround). In the future we should support both postal codes and ports. |
string |
None. |
| ServiceLevelCode |
The code of the shipment's service level ("ROUTINE", "PRIORITY" or "EMERGENCY"). This is used to determine if the shipment is restricted. |
string |
None. |