Name | Description | Type | Additional information |
---|---|---|---|
AccountNumber |
The shippers account number |
string |
Required Max length: 20 |
OrderDateTime |
Date/time order was created in system (UTC) (yyyy-MM-dd HH:mm:ss) |
string |
Required Max length: 16 |
TrackingNumber |
Tracking number used to identify shipment |
string |
Required Max length: 50 |
OfficeCode |
Office (code) assigned to manage the shipment |
string |
Required Max length: 10 |
PickupCompanyName |
Company name at pickup address |
string |
Required Max length: 50 |
PickupAddress1 |
First line of street address |
string |
Max length: 50 |
PickupAddress2 |
Second line of street address |
string |
Max length: 50 |
PickupAddress3 |
Third line of street address |
string |
Max length: 50 |
PickupCityName |
City name at pickup address |
string |
Required Max length: 50 |
PickupStateProvID |
State or province code at pickup address |
string |
Max length: 3 |
PickupPostalCode |
Postal code at pickup address |
string |
Max length: 10 |
PickupCountryID |
Country ID at pickup address (ie. US) |
string |
Required Max length: 10 |
PickupContact |
Name of contact at pickup |
string |
Max length: 50 |
DeliveryCompanyName |
Company name at delivery address |
string |
Required Max length: 50 |
DeliveryAddress1 |
First address line at delivery address |
string |
Max length: 50 |
DeliveryAddress2 |
Second address line at delivery address |
string |
Max length: 50 |
DeliveryAddress3 |
Third address line at delivery address |
string |
Max length: 50 |
DeliveryCityName |
City name at delivery address |
string |
Required Max length: 50 |
DeliveryStateProvID |
State or province code at delivery address |
string |
Max length: 3 |
DeliveryPostalCode |
Postal code at delivery address |
string |
Max length: 10 |
DeliveryCountryID |
Country code at delivery address (ie. US) |
string |
Required Max length: 2 |
DeliveryContact |
Name of contact at delivery |
string |
Max length: 50 |
Reference |
Main reference value |
string |
Max length: 50 |
Reference2 |
Other reference value |
string |
Max length: 50 |
Reference3 |
Other reference value |
string |
Max length: 50 |
Reference4 |
Other reference value |
string |
Max length: 50 |
Reference5 |
Other reference value |
string |
Max length: 50 |
Reference6 |
Other reference value |
string |
Max length: 50 |
Reference7 |
Other reference value |
string |
Max length: 50 |
Reference8 |
Other reference value |
string |
Max length: 50 |
Reference9 |
Other reference value |
string |
Max length: 50 |
Pieces |
Number of pieces in shipment |
string |
Required |
Weight |
Total weight of shipment |
string |
None. |
WeightUOM |
Weight unit of measure (LB,KG) |
string |
None. |
Status |
Status of shipment |
string |
None. |
PODName |
Text of signature name on proof of delivery |
string |
None. |
PODDateTime |
Date/time of delivery |
string |
None. |
PODDateTimeUTC |
Date/time of delivery (UTC) |
string |
None. |
QuotedDeliveryDateTime |
Quote delivery date/time |
string |
None. |
QuotedDeliveryDateTimeUTC |
Quote delivery date/time (UTC) |
string |
None. |
PickupAttempts |
Number of pickup attempts |
string |
None. |
DeliveryAttempts |
Number of delivery attempts |
string |
None. |
PickupWaitingMinutes |
Amount of waiting time at pickup in minutes |
string |
None. |
DeliveryWaitingMinutes |
Amount of waiting time at delivery in minutes |
string |
None. |
PickupDistance |
Pickup distance from pickup address to airport |
string |
None. |
DeliveryDistance |
Delivery distance from airport to delivery address |
string |
None. |
DistanceUOM |
Distance unit of measure (MI,KM) |
string |
None. |
PickupAddressCode |
Code that identifies pickup address |
string |
None. |
DeliveryAddressCode |
Code that identifies delivery address |
string |
None. |
Contents |
Contents of shipment |
string |
None. |
CalledInBy |
Name of person who called in the order |
string |
None. |
ServiceID |
Used to identify type of service used |
string |
None. |
TotalCharges |
Total charges |
string |
None. |
BaseCharge |
Base charge |
string |
None. |
WeightCharge |
Excess weight charge |
string |
None. |
FuelCharge |
Fuel surcharge |
string |
None. |
SecurityCharge |
Security surcharge |
string |
None. |
PickupMileageCharge |
Pickup mileage charge |
string |
None. |
PickupAttemptCharge |
Pickup attempt charge |
string |
None. |
PickupWaitingCharge |
Pickup waiting charge |
string |
None. |
PickupWeekendCharge |
Pickup weekend charge |
string |
None. |
DeliveryMileageCharge |
Delivery mileage charge |
string |
None. |
DeliveryAttemptCharge |
Delivery attempt charge |
string |
None. |
DeliveryWaitingCharge |
Delivery waiting time charge |
string |
None. |
DeliveryWeekendCharge |
Delivery weekend charge |
string |
None. |
HoldAndDeliver |
Hold and delivery surcharge |
string |
None. |
SecurityScreeningCharge |
Security screening charge |
string |
None. |
OtherCharge |
Other charges |
string |
None. |
OriginAirportCode |
Origin airport |
string |
None. |
DestinationAirportCode |
Destination airport |
string |
None. |
TotalDistance |
Total distance from pickup to delivery address |
string |
None. |
UpdatedPickupDateTime |
Updated pickup date/time |
string |
None. |
UpdatedPickupDateTimeUTC |
Updated pickup date/time (UTC) |
string |
None. |
ActualPickupArrival |
Actual pickup date/time |
string |
None. |
ActualPickupArrivalUTC |
Actual pickup date/time (UTC) |
string |
None. |
Routing |
Routing of the order |
string |
None. |
InvoiceList |
List of comma separate invoices |
string |
None. |
ShipmentGUID |
Internal shipment identifier |
string |
None. |
ShipmentNumber |
Unique system generated shipment identifier |
string |
None. |