Get tracking information.
GET /tracks
Elements
Request
Name | Type | Description |
---|---|---|
ReferenceNumber | string | Tracking number. |
Response
Name | Type | Description |
---|---|---|
POD | string | Proof of Delivery image URL. |
TrackingDetail | array of TrackingDetail | A list of tracking information. |
TrackingDetail
Name | Type | Description |
---|---|---|
TrackingNumber | string | Tracking number. |
TrackingDate | date | Tracking date in country local time zone. Format: yyyy/MM/dd HH:mm:ss tt |
TrackingUTCDate | date | Tracking date in UTC. Format: yyyy/MM/dd HH:mm:ss tt |
TrackingCountry | string | Tracking country in ISO Alpha-2 code |
TrackingLocation | string | Tracking location name. |
TrackingEventName | string | Event name. |
TrackingEventCode | string | Event code. |
TrackingNotes | string | Event notes. |
TrackingError | string | Error message. |
Sample
Request
GET /api2/tracks?ReferenceNumber=100000003740 HTTP/1.1
Host: api.postshipping.com
Content-Type: application/json
Token: WS_PSTest
Response
{
"POD": "https://ws01.ffdx.net/v4/printdoc/docPOD.aspx?accessid=371F1D35972BA6B61915929CFC615642&shipno=100000003552"
"TrackingDetail": [
{
"TrackingUTCDate": "2017/08/06 04:00:00 PM",
"TrackingError": "",
"TrackingCountry": "SG",
"TrackingEventCode": "3",
"TrackingLocation": "SINGAPORE",
"TrackingDate": "2017/08/06 12:00:00 AM",
"TrackingEventName": "Departed to Singapore",
"TrackingNotes": "",
"TrackingNumber": "100000003740"
},
{
"TrackingUTCDate": "2017/08/07 02:00:00 AM",
"TrackingError": "",
"TrackingCountry": "SG",
"TrackingEventCode": "1",
"TrackingLocation": "SINGAPORE",
"TrackingDate": "2017/08/07 10:00:00 AM",
"TrackingEventName": "Delivered",
"TrackingNotes": "John",
"TrackingNumber": "100000003740"
}
]
}