Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

TrackDetail Type

Indicates the tracking details.

Remarks

This type contains the results of a tracking search made after a call to the TrackShipment method. The fields contained by this type are listed below.

Fields

Address1
String

Line 1 in the location address where a tracking event occurred (by package). This contains street prefix, street name, street type.

This is not available for USPS tracking requests.

Address2
String

Line 2 in the location address where a tracking event occurred (by package). This contains building, floor, room, suite and PO Box Number.

This is not available for USPS tracking requests.

City
String

Name of the city where the tracking event occurred. This is returned in the server reply for each tracking event.

Company
String

Company name if delivered to a company for a given TrackingNumber.

This field is applicable only to USPS and is returned after a call to the TrackShipment method for each tracking event returned by the USPS Server.

CountryCode
String

Country code where the tracking event happened.

For FedEx, this is returned if the country, where the scanning activity happened, is US or CA (for Canada).

Date
String

Date the tracking event happened.

Exception
String

The most recent status exception for the tracking event. This is only available for FedEx, and is applicable for Express services only.

Location
String

Location description where a tracking event occurred.

This is only applicable to UPS.

Other
String

Other information about the tracking event.

This is only applicable to USPS and will be populated with any additional information in the tracking event that is not provided by the other fields. Examples of this are "AuthorizedAgent" and "Signer" (when there is a signer for that event).

The format of this property is a comma-separated "name=value" list.

State
String

State or province code where the tracking event occurred. This is a two-letter standard abbreviation.

Status
String

Literal description of the tracking event.

For UPS, possible values are:

In Transit
Delivered
Exception
Pickup
Manifest Pickup

For USPS, if RequestType is set to rtSummary, this will contain a description of the current status of the package being tracked. In this case, Status will contain the entire summary and none of the other fields will be populated. For example, this field might contain: "Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801."

If there is a problem with a specific TrackingNumber within the request, the response will raise an error which will be returned in the Status field that pertains to the specific TrackingNumber.

When RequestType is set to rtDetail however, this field will contain a description of the event type for the current tracking event. For example, "ENROUTE", "DELIVERED", "ACCEPTANCE", etc. The rest of the fields will be populated with more details of the event.

Time
String

Time the tracking event occurred.

ZipCode
String

Postal code where the tracking event happened. Returned if the country, where the scanning activity happened, supports postal-code system.

Constructors

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0