Shipment Tracking Interface Response
The following image shows the structure for Shipment Tracking Interface Response, which contains the following components: Shipment Information and Package Information.
The following table lists the integration components in the Shipment Tracking Interface Response ASI.
| Integration Component | XML Tag | User Keys |
|---|---|---|
Shipment Information |
ShipmentInformation |
No user keys |
Package Information |
PackageInformation |
No user keys |
Shipment Information Fields in Shipment Tracking Interface Response ASI
The following table lists the Shipment Information fields and their attributes in the Shipment Tracking Interface Response ASI. Fields without a length specified do not have a maximum length associated with them.
| Name | XML Tag | Data Type | Length | Req. | Notes |
|---|---|---|---|---|---|
Response Code |
ResponseCode |
DTYPE_TEXT |
10 |
Yes |
None |
Response Message |
ResponseMessage |
DTYPE_TEXT |
100 |
Yes |
None |
Shipment Identification Number |
ShipmentIdentificationNumber |
DTYPE_TEXT |
50 |
C |
Tracking number at the shipment level (logical construct). Conditionally required if Shipment Reference Number is not provided. |
Shipment Pickup Date |
ShipmentPickupDate |
DTYPE_UTCDATETIME |
10 |
No |
None |
Shipment Reference Number |
ShipmentReferenceNumber |
DTYPE_TEXT |
30 |
C |
Conditionally required if Shipment Identification Number is not provided. |
Shipment Scheduled Delivery Date |
ShipmentScheduledDeliveryDate |
DTYPE_UTCDATETIME |
10 |
No |
None |
Shipment Service Description |
ShipmentServiceDescription |
DTYPE_TEXT |
100 |
No |
None |
Shipment Ship To Address Line 1 |
ShipmentShipToAddressLine1 |
DTYPE_TEXT |
200 |
No |
None |
Shipment Ship To Address Line 2 |
ShipmentShipToAddressLine2 |
DTYPE_TEXT |
100 |
No |
None |
Shipment Ship To City |
ShipmentShipToCity |
DTYPE_TEXT |
50 |
No |
None |
Shipment Ship To Country |
ShipmentShipToCountry |
DTYPE_TEXT |
30 |
No |
None |
Shipment Ship To Postal Code |
ShipmentShipToPostalCode |
DTYPE_TEXT |
30 |
No |
None |
Shipment Ship To State |
ShipmentShipToState |
DTYPE_TEXT |
10 |
No |
None |
Shipper Number |
ShipperNumber |
DTYPE_TEXT |
60 |
Y |
None |
Package Information Fields in Shipment Tracking Interface Response ASI
The following table lists the Package Information fields and their attributes in the Shipment Tracking Interface Response ASI. Fields without a length specified do not have a maximum length associated with them.
| Name | XML Tag | Data Type | Length | Req. |
|---|---|---|---|---|
Comments |
Comments |
DTYPE_TEXT |
100 |
No |
Package Activity Date |
PackageActivityDate |
DTYPE_DATE |
20 |
No |
Package Activity Location City |
PackageActivityLocationCity |
DTYPE_TEXT |
20 |
No |
Package Activity Location Country |
PackageActivityLocationCountry |
DTYPE_TEXT |
20 |
No |
Package Activity Location Description |
PackageActivityLocationDescription |
DTYPE_TEXT |
20 |
No |
Package Activity Location Signed For By Name |
PackageActivityLocationSignedForByName |
DTYPE_TEXT |
20 |
No |
Package Activity Status Description |
PackageActivityStatusDescription |
DTYPE_TEXT |
20 |
No |
Package Activity Time |
PackageActivityTime |
DTYPE_TIME |
20 |
No |
Package Tracking Number |
PackageTrackingNumber |
DTYPE_TEXT |
20 |
Yes |
Response Code |
ResponseCode |
DTYPE_TEXT |
10 |
No |
Response Message |
ResponseMessage |
DTYPE_TEXT |
100 |
No |