Tracking Updates
The /track endpoint is used to track the journey of a given shipment. This is often used by companies wishing to display tracking updates in their customer portals, or for the customer service teams when dealing with enquiries. You'll need either your easyship_shipment-_id or your platform_order_number as identifiers.
Get Current Status
You're able to return the current status of a given shipment by using the tracking endpoint and specifying the easyship_shipment_id or the platform_order_number as a parameter.
GET api.easyship.com/track/v1/status?easyship_shipment_id=easyship_shipment_id&platform_order_number=platform_order_number&per_page=per_page&page=page
{
"total_page": 1,
"current_page": 1,
"shipments": [
"easyship_shipment_id": "ESHK0001785",
"platform_order_number": "#1234",
"status":"Out For Delivery"
]
}
}
Your response would include a status, which you would pass on.
Retrieve All Checkpoints
When you need to retrieve the history of a given shipment, you can pull all of the checkpoints that the shipment has gone through.
To get this information, you just need to call the track/v1/checkpoints resource, again with the easyship_shipment_id or platfrom_order_numberas the identifier in the parameters.
{
"total_page": 1,
"current_page": 1,
"shipments": [
"easyship_shipment_id": "ESHK0001785",
"platform_order_number": "#1234",
"origin":"Hong Kong",
"destination":"United States",
"status":"Out For Delivery",
"checkpoints":[
{
"order_number":115,
"handler":"Ups",
"message":"Out For Delivery",
"location":"Hollywood, FL, US",
"city":"Hollywood",
"country_name":null,
"country_iso3":"USA",
"coordinates":"[]",
"state":"FL",
"zip":null,
"checkpoint_time":"2016-08-05T09:20:00.000Z",
"handler_created_at":"2016-08-05T13:54:00.000Z"
},
{
"order_number":114,
"handler":"Ups",
"message":"Arrival Scan",
"location":"Hollywood, FL, US",
"city":"Hollywood",
"country_name":null,
"country_iso3":"USA",
"coordinates":"[]",
"state":"FL",
"zip":null,
"checkpoint_time":"2016-08-05T08:07:00.000Z",
"handler_created_at":"2016-08-05T13:54:00.000Z"
},
{
"order_number":112,
"handler":"Ups",
"message":"Departure Scan",
"location":"Miami, FL, US",
"city":"Miami",
"country_name":null,
"country_iso3":"USA",
"coordinates":"[]",
"state":"FL",
"zip":null,
"checkpoint_time":"2016-08-05T07:14:00.000Z",
"handler_created_at":"2016-08-05T13:54:00.000Z"
},
{
"order_number":111,
"handler":"Ups",
"message":"Arrival Scan",
"location":"Miami, FL, US",
"city":"Miami",
"country_name":null,
"country_iso3":"USA",
"coordinates":"[]",
"state":"FL",
"zip":null,
"checkpoint_time":"2016-08-05T06:32:00.000Z",
"handler_created_at":"2016-08-05T10:53:57.000Z"
},
{
"order_number":110,
"handler":"Ups",
"message":"Departure Scan",
"location":"Louisville, KY, US",
"city":"Louisville",
"country_name":null,
"country_iso3":"USA",
"coordinates":"[]",
"state":"KY",
"zip":null,
"checkpoint_time":"2016-08-05T04:15:00.000Z",
"handler_created_at":"2016-08-05T10:53:57.000Z"
},
{
"order_number":109,
"handler":"Ups",
"message":"Import Scan",
"location":"Louisville, KY, US",
"city":"Louisville",
"country_name":null,
"country_iso3":"USA",
"coordinates":"[]",
"state":"KY",
"zip":null,
"checkpoint_time":"2016-08-05T00:08:00.000Z",
"handler_created_at":"2016-08-05T04:53:46.000Z"
},
{
"order_number":108,
"handler":"Ups",
"message":"Arrival Scan",
"location":"Louisville, KY, US",
"city":"Louisville",
"country_name":null,
"country_iso3":"USA",
"coordinates":"[]",
"state":"KY",
"zip":null,
"checkpoint_time":"2016-08-04T16:38:00.000Z",
"handler_created_at":"2016-08-04T22:53:38.000Z"
},
{
"order_number":107,
"handler":"Ups",
"message":"Departure Scan",
"location":"Kwai Chung, HK",
"city":"Kwai Chung",
"country_name":null,
"country_iso3":"HKG",
"coordinates":"[]",
"state":null,
"zip":null,
"checkpoint_time":"2016-08-04T15:34:00.000Z",
"handler_created_at":"2016-08-04T10:53:21.000Z"
},
{
"order_number":106,
"handler":"Ups",
"message":"Departure Scan",
"location":"Chek Lap Kok, HK",
"city":"Chek Lap Kok",
"country_name":null,
"country_iso3":"HKG",
"coordinates":"[]",
"state":null,
"zip":null,
"checkpoint_time":"2016-08-04T10:01:00.000Z",
"handler_created_at":"2016-08-04T04:53:03.000Z"
},
{
"order_number":105,
"handler":"Ups",
"message":"Departure Scan",
"location":"Anchorage, AK, US",
"city":"Anchorage",
"country_name":null,
"country_iso3":"USA",
"coordinates":"[]",
"state":"AK",
"zip":null,
"checkpoint_time":"2016-08-04T06:59:00.000Z",
"handler_created_at":"2016-08-04T19:53:35.000Z"
},
{
"order_number":104,
"handler":"Ups",
"message":"Arrival Scan",
"location":"Anchorage, AK, US",
"city":"Anchorage",
"country_name":null,
"country_iso3":"USA",
"coordinates":"[]",
"state":"AK",
"zip":null,
"checkpoint_time":"2016-08-04T03:33:00.000Z",
"handler_created_at":"2016-08-04T13:53:26.000Z"
},
{
"order_number":103,
"handler":"Ups",
"message":"Origin Scan",
"location":"Kwai Chung, HK",
"city":"Kwai Chung",
"country_name":null,
"country_iso3":"HKG",
"coordinates":"[]",
"state":null,
"zip":null,
"checkpoint_time":"2016-08-03T19:34:00.000Z",
"handler_created_at":"2016-08-03T13:33:23.000Z"
},
{
"order_number":102,
"handler":"Ups",
"message":"Pickup Scan",
"location":"Kwai Chung, HK",
"city":"Kwai Chung",
"country_name":null,
"country_iso3":"HKG",
"coordinates":"[]",
"state":null,
"zip":null,
"checkpoint_time":"2016-08-03T17:30:00.000Z",
"handler_created_at":"2016-08-03T10:33:15.000Z"
},
{
"order_number":101,
"handler":"Ups",
"message":"Order Processed: Ready for UPS",
"location":"HK",
"city":null,
"country_name":null,
"country_iso3":"HKG",
"coordinates":"[]",
"state":null,
"zip":null,
"checkpoint_time":"2016-08-02T03:24:16.000Z",
"handler_created_at":"2016-08-03T04:33:02.000Z"
},
{
"order_number":2,
"handler":"UPS",
"message":"Your package has been prepared and is awaiting pickup from UPS",
"location":null,
"city":null,
"country_name":"Hong Kong",
"country_iso3":"HKG",
"coordinates":null,
"state":null,
"zip":null,
"checkpoint_time":"2016-08-03T12:33:01.970Z",
"handler_created_at":null
},
{
"order_number":1,
"handler":"UPS",
"message":"Your package is currently being scheduled to be picked up.",
"location":null,
"city":null,
"country_name":"Hong Kong",
"country_iso3":"HKG",
"coordinates":null,
"state":null,
"zip":null,
"checkpoint_time":"2016-08-03T12:33:01.082Z",
"handler_created_at":null
}
]
}
}
For a full list of status messages, you can check the test( input ) API Reference link to go here.
Updated over 6 years ago