| Name | Description | Type | Additional information |
|---|---|---|---|
| ShipmentNumber |
Unique shipment number assigned by the system to each order |
integer |
Required |
| TrackingNumber |
Tracking number or (air)waybill number, this is optional, typically the ShipmentNumber is the main tracking number for the shipment |
string |
None. |
| Pieces |
Number of pieces in the shipment |
integer |
Required |
| Weight |
Total actual weight of the shipment |
decimal number |
None. |
| WeightUOM |
Weight unit of measure (LB,KG) |
string |
None. |
| ServiceCode |
Code of the service required for shipment |
string |
Required Max length: 15 |
| ServiceName |
Name of the service used for shipment |
string |
Required Max length: 40 |
| Contents |
The description of the contents at of the shipment |
string |
Max length: 100 |
| Reference |
Customer specified reference value for the shipment |
string |
Max length: 50 |
| OtherReference1 |
Custom reference value |
string |
Max length: 50 |
| OtherReference2 |
Custom reference value |
string |
Max length: 50 |
| OtherReference3 |
Custom reference value |
string |
Max length: 50 |
| OtherReference4 |
Custom reference value |
string |
Max length: 50 |
| OtherReference5 |
Custom reference value |
string |
Max length: 50 |
| OtherReference6 |
Custom reference value |
string |
Max length: 50 |
| OtherReference7 |
Custom reference value |
string |
Max length: 50 |
| OtherReference8 |
Custom reference value |
string |
Max length: 50 |
| PickupCompanyName |
The name of the company at the pickup location |
string |
Required Max length: 50 |
| PickupAddress1 |
Address line 1 at the pickup location |
string |
Max length: 50 |
| PickupAddress2 |
Address line 2 at the pickup location |
string |
Max length: 50 |
| PickupAddress3 |
Address line 3 at the pickup location |
string |
Max length: 50 |
| PickupCityName |
The city name at the pickup location |
string |
Required Max length: 50 |
| PickupStateProvID |
The state or province at the pickup location |
string |
Max length: 3 |
| PickupPostalCode |
The postal code at the pickup location |
string |
Max length: 10 |
| PickupCountryID |
The country identifier at the pickup location |
string |
Required Max length: 2 |
| PickupCountryName |
The name of the country |
string |
Max length: 30 |
| PickupPersonToSee |
The person to see at the pickup location |
string |
Max length: 50 |
| PickupPhoneNumber |
The phone number at the pickup location |
string |
Max length: 25 |
| DeliveryCompanyName |
The name of the company at the pickup location |
string |
Required Max length: 50 |
| DeliveryAddress1 |
The address line 1 at the delivery location |
string |
Max length: 50 |
| DeliveryAddress2 |
The address line 2 at the delivery location |
string |
Max length: 50 |
| DeliveryAddress3 |
The address line 3 at the delivery location |
string |
Max length: 50 |
| DeliveryCityName |
The name of the city at the delivery location |
string |
Required Max length: 50 |
| DeliveryStateProvID |
The state or province at the delivery location |
string |
Max length: 3 |
| DeliveryPostalCode |
The postal code at the delivery location |
string |
Max length: 10 |
| DeliveryCountryID |
The country ID at the delivery location (ie. US) |
string |
Required Max length: 2 |
| DeliveryCountryName |
The country name at the delivery location (ie. US) |
string |
Required Max length: 30 |
| DeliveryAttention |
The attention to person at the delivery location |
string |
Max length: 50 |
| DeliveryPhoneNumber |
The phone number at the delivery location |
string |
Max length: 25 |
| DeliveryEmailAddress |
The email address at the delivery location |
string |
Max length: 100 |
| ReadyDateTime |
The date/time the shipment will be ready in the timezone of the pickup |
string |
Required |
| EstimatedPickupDateTime |
The estimated date/time of pickup in the timezone of the pickup |
string |
Required |
| ActualPickupDateTime |
The actual date/time of pickup in the timezone of the pickup |
string |
None. |
| EstimatedDeliveryDateTime |
The estimated date/time of delivery in the timezone of the delivery |
string |
None. |
| PodSignature |
The proof of delivery signature |
string |
None. |
| PodDateTime |
The actual delivery date/time in timezone of the delivery |
string |
None. |
| OrderStatus |
The status (code) of the order |
string |
Required |
| OrderStatusName |
The current status description of the shipment |
string |
None. |
| DepartAirportID |
Departing airport code |
string |
Max length: 3 |
| DepartAirlineName |
Departing airline name |
string |
None. |
| DepartIataID |
Departing airline code |
string |
None. |
| DepartFlightNumber |
Departing flight number |
string |
None. |
| DepartEstimatedDateTime |
Estimated depart date/time in timezone of departing airport |
string |
None. |
| DepartActualDateTime |
Actual depart date/time in timezone of departing airport |
string |
None. |
| ArriveAirportID |
Arriving airport code |
string |
Max length: 3 |
| ArriveAirlineName |
Arrivaing airline name |
string |
None. |
| ArriveIataID |
Arriving airline code |
string |
None. |
| ArriveFlightNumber |
Arriving flight number |
string |
None. |
| ArriveEstimatedDateTime |
Estimated arrival time in timezone of arriving airport |
string |
None. |
| ArriveActualDateTime |
Actual arrival time in timezone of arriving airport |
string |
None. |
| OrderReceivedDateTimeUTC |
The date/time that the order was received in the system (UTC time) |
string |
None. |
| Itinerary |
The itinerary of the shipment |
Collection of ItineraryItem |
None. |
| LocationLatitude |
The current location of the shipment (latitude) |
decimal number |
None. |
| LocationLongitude |
The current location of the shipment (longitude) |
decimal number |
None. |
| IsSuccessful |
If true, then method call was successful |
boolean |
None. |
| ErrorMessage |
Contains an error message is method call failed |
string |
None. |