Changelog
v4.1.10 (2022-04-01)
Update | Resources |
---|---|
New query param tracking_numbers . Can search the tracking by specific tracking numbers. Use comma to separate multiple values. (Example: 101,102,103) | GET /trackings |
v4.1.9 (2022-01-26)
Update | Resources |
---|---|
New field order_number in the tracking object. To indicate the unique numeric identifier for the order for use by shop owner and customerPlease be noted that the field will come into action from est. 24 Feb | POST /trackings PUT /trackings/:slug/:tracking_number PUT /trackings/:id GET /trackings/:slug/:tracking_number GET /trackings/:id |
Add new subtag Pending_002 . It represents the shipments are pending due to no connection with carrier accountsPlease be noted that the subtag will come into action from est. 17 Feb | GET /trackings GET /trackings/:slug/:tracking_number |
v4.1.8 (2022-01-14)
Update | Resources |
---|---|
New field aftership_estimated_delivery_date in the tracking object. To indicate when the shipment should arrive.Please be noted that the whole aftership_estimated_delivery_date object will be released in February 2022. | POST /trackings PUT /trackings/:slug/:tracking_number PUT /trackings/:id GET /trackings/:slug/:tracking_number GET /trackings/:id |
v4.1.7 (2021-12-07)
Update | Resources |
---|---|
New field order_tags in the tracking object. The tags of the order. | POST /trackings PUT /trackings/:slug/:tracking_number PUT /trackings/:id GET /trackings/:slug/:tracking_number GET /trackings/:id |
v4.1.6 (2021-11-29)
Update | Resources |
---|---|
Detect Courier API endpoint now supports origin_country_iso3 and destination_country_iso3 . | POST /couriers/detect |
v4.1.4 (2021-11-03)
Update | Resources |
---|---|
New field on_time_status in the tracking object. To indicate if the tracking is delivered on time. | POST /trackings PUT /trackings/:slug/:tracking_number PUT /trackings/:id GET /trackings/:slug/:tracking_number GET /trackings/:id |
New field on_time_difference in the tracking object. To indicate the difference (in day) to the on time date. | POST /trackings PUT /trackings/:slug/:tracking_number PUT /trackings/:id GET /trackings/:slug/:tracking_number GET /trackings/:id |
v4.1.3 (2021-07-27)
Update | Resources |
---|---|
Create trackings API endpoint now supports updating order_date . | POST /trackings |
v4.1.2 (2021-06-16)
Update | Resources |
---|---|
Added slug_group for create tracking and detect courier endpoints. | POST /trackings POST /couriers/detect |
v4.1.1 (2021-06-15)
Update | Resources |
---|---|
Update trackings API endpoint now supports updating slug . | PUT /trackings/:slug/:tracking_number |
Latest API updates
Please pay attention to the fields expected_delivery
in the Tracking object and checkpoint_time
in the Checkpoint object that it is a string
with the following possible values:
- Empty String
- YYYY-MM-DD
- YYYY-MM-DDTHH:MM:SS
- YYYY-MM-DDTHH:MM:SS+TIMEZONE
Please also handle the updates of HTTP Status Code
v4.1.0 (2020-05-26)
Update | Resources |
---|---|
New subtag Exception_013 added to cover lost shipment cases. New field courier_redirect_link added in tracking object. Delivery instructions (delivery date or address) can be modified by visiting the link if supported by a carrier. | GET /trackings GET /trackings/:slug/:tracking_number |
New function to mark a tracking as completed. | POST /trackings/:slug/:tracking_number/mark-as-completed |
v4.0.4 (2020-04-30)
Update | Resources |
---|---|
A new tag AvailableForPickup is added.The existing subtag OutForDelivery_002 is replaced with the new subtag AvailableForPickup_001. | GET /trackings GET /trackings/:slug/:tracking_number |
v4.0.3 (2020-03-23)
Update | Resources |
---|---|
New field first_attempted_at added in tracking object. Time of the first delivery attempt made by the carrier. | GET /trackings/:id |
New field courier_tracking_link added in tracking object. Courier website direct tracking URL | GET /trackings/:id |
New field raw_tag added in checkpoint object. Status code returned by carriers | GET /trackings/:id |
v4.0.2 (2014-07-19)
Update | Resources |
---|---|
New resources to get, add or remove emails and smses | POST /notifications/:slug/:tracking_number/add POST /notifications/:slug/:tracking_number/add PUT /notifications/:slug/:tracking_number/remove |
New function to reactivate and retrack expired tracking once | POST /trackings/:slug/:tracking_number/retrack |
v4.0.1 (2014-07-09)
Update | Resources |
---|---|
New field id added in tracking object. You can use /:i to replace /:slug/:tracking_number . | GET /trackings/:id PUT /trackings/:id POST /trackings/:id DELETE /trackings/:id |
v4.0.0 (2014-06-24)
Update | Resources |
---|---|
Update HTTP Status Code, do take note of the update of meta.code - Check meta codes here | |
You can specify multiple slug in array for carrier detection | POST /couriers/detect POST /trackings |
New required_fields added for some carriers: tracking_ship_date tracking_account_number tracking_postal_code | POST /trackings GET /trackings/:slug/:tracking_number |
Return required_fields for carriers | GET /couriers/all GET /couriers |
New resource to get list of activated couriers | GET /couriers |
Update method to get full list of all couriers v3 method is GET /couriers | GET /couriers/all |
Update method to get matched courier of tracking number v3 method as GET /couriers/detect/:tracking_number | POST /couriers/detect |