[Back to area tt]

Method: detail ( on area: tt )

Authentication Required: no

Description:

Do a Track/Trace lookup on the specified LabelNumber.

Parameters

LabelNo - The label number to look up
CountryCode - The code of the country in which the label resides. Optional: If omitted, will be automatically determined. See here for a list of valid country codes.
SortByType - If set to 'true', ignores the scan date and sorts the returned scans by Pickup scans first, then Transit scans, then Delivery scans.

Returns

A data structure like the following:

{
    LabelNumber: '3a0000253492',
    Scans: [{
            Type: 'P' (or 'D' or 'T'. P is Pickup, D is Delivery and T is Transit)
            Courier: '110'
            Description: 'Pickup'
            Date: '12/10/2010 4:02:16 p.m.'
			UploadDate: '13/10/2010 4:03:12 p.m.'            
            Name: 'Whangarei'
            Status: 'PPP'
            Franchise: 'WRE'
            StatusDescription: 'Your parcel was picked up.'
            CompanyInfo: {
				ContactName: '',
				Company: 'ELEPHANT HILL ESTATE & WINERY',
				Address1: '',
				Address2: '86 CIFTON RD',
				Address3: 'TE AWANGA',
				Address4: 'HAWKES BAY',
				Address5: '',
				Address6: '',
				Address7: '06 8726060',
				Address8: '',
				Comment: ''
			}
        }, {
            ...etc
    }],
    Signature: 'http://link/to/signature.jpg'
    DistributedTo: 'Whangarei'
}

Examples

Invocation URL: /latest/tt/detail

/latest/tt/detail/3a0000253492/6?api_key=YOUR_API_KEY

[Back to area tt]