Name | Description | Type | Additional information |
---|---|---|---|
OrderStatus |
Numeric order status |
integer |
None. |
OrderState |
Order state or disposition of the order (AC=active, CN=cancelled, DL=deleted) |
string |
None. |
UpdatedDeliveryDateTime |
Raw estimated delivery date/time |
date |
None. |
DspUpdatedDeliveryDateTime |
Formatted estimated delivery date/time |
string |
None. |
ShipmentNumber |
Unique numeric shipment number |
integer |
None. |
TrackingNumber |
Airbill or tracking number (optional, use ShipmentNumber) |
string |
None. |
DspOrderNumber |
Format order number (TrackingNumber or ShipmentNumber) |
string |
None. |
PickupCompanyName |
Company name at pickup |
string |
None. |
PickupCityName |
City name at pickup |
string |
None. |
PickupStateProvID |
State/prov at pickup |
string |
None. |
PickupCountryID |
Country identifier at pickup |
string |
None. |
DspPickupLocation |
Formatted pickup address |
string |
None. |
DeliveryCompanyName |
Company name at delivery |
string |
None. |
DeliveryCityName |
City name at delivery |
string |
None. |
DeliveryStateProvID |
State/Prov at pickup |
string |
None. |
DeliveryCountryID |
Country identifier at delivery |
string |
None. |
DspDeliveryLocation |
Formatted delivery address |
string |
None. |
PickupAirportID |
Origin airport code |
string |
None. |
DeliveryAirportID |
Destination airport code |
string |
None. |
FlightInfo |
Flight information (air shipment only) |
string |
None. |
ArriveDateTime |
Arrival time of flight (if applicable) |
date |
None. |
DspArriveDateTime |
Formatted arrival time of flight (if applicable) |
string |
None. |
OrderStatusDisplay |
Formatted order status |
string |
None. |
Reference |
Main reference value for this shipment |
string |
None. |
Pieces |
Number of pieces in the shipment |
integer |
None. |
Weight |
Total weight of the shipment |
decimal number |
None. |
WeightUOM |
Weight unit of measure (LB,KG) |
string |
None. |
DispatchPickupDateTime |
Date/Time courier was dispatched to pickup (local time) |
date |
None. |
DispatchDeliveryDateTime |
Date/Time courier was dispatched to delivery (local time) |
date |
None. |
DepartDateTime |
Date/Time first flight departed (local time) |
date |
None. |
CustomerReferences |
Customer reference values for this shipment |
Collection of CustomerReference |
None. |
OtherReferences |
Other reference values for this shipment |
Collection of Reference |
None. |