| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful |
Tracking was successful (true/false) |
boolean |
Required |
| ErrorMessage |
Error message if not successful |
string |
None. |
| ShipmentNumber |
Unique system assign shipment number |
integer |
Required |
| TrackingNumber |
House waybill number |
string |
Max length: 20 |
| Pieces |
Number of pieces in shipment |
integer |
Required |
| Weight |
Total weight of shipment |
decimal number |
None. |
| WeightUOM |
Weight unit of measure (LB,KG) |
string |
Max length: 2 |
| ServiceCode |
Service code |
string |
Max length: 15 |
| ServiceName |
Service name |
string |
Max length: 40 |
| Contents |
Contents of shipment |
string |
Max length: 100 |
| Reference |
Main reference value |
string |
Max length: 50 |
| OtherReference1 |
Other reference value |
string |
Max length: 50 |
| OtherReference2 |
Other reference value |
string |
Max length: 50 |
| OtherReference3 |
Other reference value |
string |
Max length: 50 |
| OtherReference4 |
Other reference value |
string |
Max length: 50 |
| OtherReference5 |
Other reference value |
string |
Max length: 50 |
| OtherReference6 |
Other reference value |
string |
Max length: 50 |
| OtherReference7 |
Other reference value |
string |
Max length: 50 |
| OtherReference8 |
Other reference value |
string |
Max length: 50 |
| 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 |
| PickupCountryName |
Country name at pickup address |
string |
Max length: 50 |
| PickupPersonToSee |
Name of person to see at pickup address |
string |
Max length: 50 |
| PickupPhoneNumber |
Phone number at pickup address |
string |
Max length: 25 |
| PickupInstructions |
Special instructions at pickup |
string |
Max length: 500 |
| DeliveryCompanyName |
Company name at delivery address |
string |
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 |
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 |
Max length: 2 |
| DeliveryCountryName |
Country name at delivery address |
string |
Max length: 50 |
| DeliveryAttention |
Attention person at delivery address |
string |
Max length: 50 |
| DeliveryPhoneNumber |
Phone number at delivery address |
string |
Max length: 25 |
| DeliveryEmailAddress |
Email address at delivery address |
string |
Max length: 100 |
| DeliveryInstructions |
Special instructions at delivery |
string |
Max length: 500 |
| ReadyDateTime |
Date/Time package is ready for pickup in timezone of pickup address (yyyy-MM-dd HH:mm) |
string |
Required Max length: 16 |
| EstimatedPickupDateTime |
Estimated date/time that shipment will be picked-up in timezone of pickup (yyyy-MM-dd HH:mm) |
string |
Required Max length: 16 |
| ActualPickupDateTime |
Actual date/time that shipment was picked-up in timezone of pickup (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
| EstimatedDeliveryDateTime |
Estimated delivery date/time in timezone of delivery (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
| PodSignature |
The text name of signature for delivery |
string |
Max length: 50 |
| PodDateTime |
The date/time that shipment was delivered (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
| OrderStatus |
The status code of the order |
string |
Required |
| OrderStatusName |
The full name of the status |
string |
Required |
| DepartAirportID |
The departure airport ID |
string |
Max length: 3 |
| DepartAirlineName |
The name of airline at departure |
string |
Max length: 50 |
| DepartIataID |
The departure airlines IATA ID code |
string |
Max length: 2 |
| DepartFlightNumber |
The flight number of departure |
string |
Max length: 20 |
| DepartEstimatedDateTime |
The estimated time of departure in departure timezone (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
| DepartActualDateTime |
The actual time of departure in departure timezone (yyyy-MM_dd HH:mm) |
string |
Max length: 16 |
| ArriveAirportID |
The arrival airport ID |
string |
Max length: 3 |
| ArriveAirlineName |
The name of the arrival airline |
string |
Max length: 50 |
| ArriveIataID |
The IATA ID of the arrival airline |
string |
Max length: 2 |
| ArriveFlightNumber |
The flight number of the arrival airline |
string |
Max length: 20 |
| ArriveEstimatedDateTime |
The estimated arrival time in timezone of arrival airport (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
| ArriveActualDateTime |
The actual arrival time in timezone of arrival airport (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
| OrderReceivedDateTimeUTC |
The date/time the order was received (UTC) (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
| ReadyDateTimeUTC |
The ready datetime in UTC (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
| EstimatedPickupDateTimeUTC |
The estimated pickup time in UTC (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
| ActualPickupDateTimeUTC |
The actual pickup time in UTC (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
| EstimatedDeliveryDateTimeUTC |
The estimated delivery date/time in UTC (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
| PodDateTimeUTC |
The actual delivery date/time in UTC (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
| PieceReferences |
Comma separated list of reference assigned to pieces (detail) |
string |
None. |
| WaybillNumberFirst |
MAWB # assigned to first manifest |
string |
None. |
| WaybillNumberLast |
MAWB # assigned to last manifest (same as MawbNumberFirst if only one manifest) |
string |
None. |