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

Shipment Tracking Interface Response


Figure 33 describes the structure for Shipment Tracking Interface Response.

Figure 33.  Shipment Tracking Interface Response ASI

Click for full size image

Table 70 lists all the integration components of this ASI.

Table 70.  Shipment Tracking Interface Response ASI Integration Components
Integration Component
XML Tag
User Keys
Shipment Information
 
No user keys for this primary integration component.
Package Information
PackageInformation
No user keys.

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

Table 71.  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
ShipmentIdentification
Number
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
ShipmentReference
Number
DTYPE_TEXT
30
C
Conditionally required if Shipment Identification Number not provided.
Shipment Scheduled Delivery Date
ShipmentScheduled
DeliveryDate
DTYPE_UTCDATE
TIME
10
 
 
Shipment Service Description
ShipmentService
Description
DTYPE_TEXT
100
 
 
Shipment Ship To Address Line 1
ShipmentShipToAddress
Line1
DTYPE_TEXT
200
 
 
Shipment Ship To Address Line 2
ShipmentShipToAddress
Line2
DTYPE_TEXT
100
 
 
Shipment Ship To City
ShipmentShipToCity
DTYPE_TEXT
50
 
 
Shipment Ship To Country
ShipmentShipToCountry
DTYPE_TEXT
30
 
 
Shipment Ship To Postal Code
ShipmentShipToPostal
Code
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
PackageActivityLocation
City
DTYPE_TEXT
20
 
 
Package Activity Location Country
PackageActivityLocation
Country
DTYPE_TEXT
20
 
 
Package Activity Location Description
PackageActivityLocation
Description
DTYPE_TEXT
20
 
 
Package Activity Location Signed For By Name
PackageActivityLocation
SignedForByName
DTYPE_TEXT
20
 
 
Package Activity Status Description
PackageActivityStatus
Description
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 
 Published: 15 May 2003