Changelog

2024-07 (2024-07-11)

Change	Before	After
Base URL	https://api.aftership.com/tracking/2024-04	https://api.aftership.com/tracking/2024-07
as-api-version header’s value	2024-04	2024-07
Deprecating notifications endpoints	POST /notifications/{tracking_id}/add POST notifications/{tracking_id}/remove POST /notifications/{slug}/{tracking_number}/add POST /notifications/{slug}/{tracking_number}/remove GET /notifications/{tracking_id} GET /notifications/{slug}/{tracking_number}	Endpoints are removed
Deprecating last checkpoint endpoints	GET /last_checkpoint/{tracking_id} GET /last_checkpoint/{slug}/{tracking_number}	Endpoints are removed
API Rate limit changes	All endpoints from sharing one rate limit	Each of the endpoints now having its dedicated rate limit
Tracking response new fields: delivery_location_type legacy_id	-	delivery_location_type legacy_id
Estimated delivery date response new fields: id	-	id
Create/update tracking request body new fields: shipment_weight	-	shipment_weight
Merge shipment_weight and shipment_weight_unit into shipment_weight object.	{"shipment_weight": 10.2, "shipment_weight_unit": "kg"}	{"shipment_weight":{"value": 10.2, "unit": "kg"}}
tracking.checkpoints[x].events.code supports new enum values: carrier_pickup_failed dropped_off_for_carrier_pickup delayed handed_over_to_last_mile_carrier received_by_last_mile_carrier returning_to_sender address_corrected customer_enquiry_raised address_verified	-	carrier_pickup_failed dropped_off_for_carrier_pickup delayed handed_over_to_last_mile_carrier received_by_last_mile_carrier returning_to_sender address_corrected customer_enquiry_raised address_verified
tracking.order_promised_delivery_date supports new value formats: - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ	YYYY-MM-DD	- YYYY-MM-DD - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ
Allow to update tracking_ship_date for non-pending tracking	-	tracking_ship_date
The length of the tracking ID has changed from 24 characters to 32 characters.	id: "q12m966070t6vlvwnspqn02o"	id: "8243e0c68fe64c7a871ef868cdb7899d"
smses no longer support comma-separated string format when PUT or POST a tracking.	["+5321288112","+893636771"] or "+5321288112, +893636771"	["+5321288112","+893636771"]
emails no longer support comma-separated string format when PUT or POST a tracking.	["[email protected]","[email protected]"] or "[email protected],[email protected]"	["[email protected]","[email protected]"]
slug no longer supports comma-separated string format when detecting couriers.	["ups","fedex"] or "ups, fedex"	["ups","fedex"]
Removed the tracking object wrapper from the response body.	{"meta": {"code": 201},"data": {"tracking": {"id": "nke21z8sryxsqlyh2o45d02f"…}}}	{"meta": {"code": 201},"data": {{"id": "nke21z8sryxsqlyh2o45d02f"…}}
Removed the tracking object wrapper from the request body.	{"tracking": {"slug":fedex","tracking_number":"999737828883221"}}	{"slug": fedex","tracking_number": "999737828883221"}