Application Services Interface Reference > Predefined Application Service Interfaces > External Shipment Tracking >

Shipment Tracking Interface Response


Figure 30 describes the structure for Shipment Tracking Interface Response.

Figure 30. Shipment Tracking Interface Response ASI

Table 65 lists all the integration components of this ASI.

Table 65. Shipment Tracking Interface Response ASI Integration Components
Integration Component
XML Tag
User Keys

Shipment Information

ShipmentInformation

No user keys.

Package Information

PackageInformation

No user keys.

Table 66 lists the fields and their attributes. Fields without a length specified do not have a maximum length associated with them.

Table 66. Shipment Tracking Interface Response ASI Fields
Name
XML Tag
Data Type
Length
Req.
Notes

Shipment Information

Response Code

ResponseCode

DTYPE_TEXT

10

Y

 

Response Message

ResponseMessage

DTYPE_TEXT

100

Y

 

Shipment Identification Number

ShipmentIdentificationNumber

DTYPE_TEXT

50

C

Tracking number at the shipment level (logical construct). Conditionally required if Shipment Reference Number not provided.

Shipment Pickup Date

ShipmentPickupDate

DTYPE_UTCDATE
TIME

10

 

 

Shipment Reference Number

ShipmentReferenceNumber

DTYPE_TEXT

30

C

Conditionally required if Shipment Identification Number not provided.

Shipment Scheduled Delivery Date

ShipmentScheduledDeliveryDate

DTYPE_UTCDATE
TIME

10

 

 

Shipment Service Description

ShipmentServiceDescription

DTYPE_TEXT

100

 

 

Shipment Ship To Address Line 1

ShipmentShipToAddressLine1

DTYPE_TEXT

200

 

 

Shipment Ship To Address Line 2

ShipmentShipToAddressLine2

DTYPE_TEXT

100

 

 

Shipment Ship To City

ShipmentShipToCity

DTYPE_TEXT

50

 

 

Shipment Ship To Country

ShipmentShipToCountry

DTYPE_TEXT

30

 

 

Shipment Ship To Postal Code

ShipmentShipToPostalCode

DTYPE_TEXT

30

 

 

Shipment Ship To State

ShipmentShipToState

DTYPE_TEXT

10

 

 

Shipper Number

ShipperNumber

DTYPE_TEXT

60

Y

 

Package Information

Comments

Comments

DTYPE_TEXT

100

 

 

Package Activity Date

PackageActivityDate

DTYPE_DATE

20

 

 

Package Activity Location City

PackageActivityLocationCity

DTYPE_TEXT

20

 

 

Package Activity Location Country

PackageActivityLocationCountry

DTYPE_TEXT

20

 

 

Package Activity Location Description

PackageActivityLocationDescription

DTYPE_TEXT

20

 

 

Package Activity Location Signed For By Name

PackageActivityLocationSignedForByName

DTYPE_TEXT

20

 

 

Package Activity Status Description

PackageActivityStatusDescription

DTYPE_TEXT

20

 

 

Package Activity Time

PackageActivityTime

DTYPE_TIME

20

 

 

Package Tracking Number

PackageTrackingNumber

DTYPE_TEXT

20

Y

 

Response Code

ResponseCode

DTYPE_TEXT

10

 

 

Response Message

ResponseMessage

DTYPE_TEXT

100

 

 

Application Services Interface Reference