Changelog

UpdateResources
Use AfterShip Predict API to provide estimated delivery dates (EDD) to customers for online orders on the product page, cart, and order checkout page. You can get the earliest date, the latest date, and the most-likely-arrival date through the AI-predictive EDD API without adding the tracking number.POST /estimated-delivery-date/predict-batch
UpdateResources
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
UpdateResources
New field order_number in the tracking object. To indicate the unique numeric identifier for the order for use by shop owner and customer
Please 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 accounts
Please be noted that the subtag will come into action from est. 17 Feb
GET /trackings
GET /trackings/:slug/:tracking_number
UpdateResources
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
UpdateResources
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
UpdateResources
Detect Courier API endpoint now supports origin_country_iso3 and destination_country_iso3 .POST /couriers/detect
UpdateResources
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
UpdateResources
Create trackings API endpoint now supports updating order_date.POST /trackings
UpdateResources
Added slug_group for create tracking and detect courier endpoints.POST /trackings
POST /couriers/detect
UpdateResources
Update trackings API endpoint now supports updating slug.PUT /trackings/:slug/:tracking_number

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

UpdateResources
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
UpdateResources
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
UpdateResources
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
UpdateResources
New resources to get, add or remove emails and smsesPOST /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 oncePOST /trackings/:slug/:tracking_number/retrack
UpdateResources
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
UpdateResources
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 detectionPOST /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 carriersGET /couriers/all
GET /couriers
New resource to get list of activated couriersGET /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