Changelog

This page contains the changelog of the current API version. For the past changelog, please refer to this page.

2026-07 (2026-07-09)

Change	Before	After
Base URL	https://api.aftership.com/tracking/2026-01	https://api.aftership.com/tracking/2026-07
as-api-version header's value	2026-01	2026-07

Change	Affected
10 new delivery sub-statuses added: Delivered_005, Exception_016, Exception_017, Exception_018, Exception_019, Exception_020, Exception_021, InTransit_011, InTransit_012, InTransit_013.	API endpoint: - GET /trackings - GET /trackings/:id - DELETE /trackings/:id - POST /trackings - PUT /trackings/:id - POST /trackings/:id/mark-as-completed - POST /trackings/:id/retrack Tracking Webhook
New field shipment_dimensions added to the tracking object. Returns the physical dimensions of the package, including length, width, and height.	API endpoint: - GET /trackings - GET /trackings/:id - DELETE /trackings/:id - POST /trackings - PUT /trackings/:id - POST /trackings/:id/mark-as-completed - POST /trackings/:id/retrack Tracking Webhook
New field checkpoints[].hash added. A unique hash identifier for each checkpoint event, which can be used for deduplication.	API endpoint: - GET /trackings - GET /trackings/:id - DELETE /trackings/:id - POST /trackings - PUT /trackings/:id - POST /trackings/:id/mark-as-completed - POST /trackings/:id/retrack Tracking Webhook
New field customers[].id added. The customer's identifier on the merchant or platform (for example, Shopify) side. This field is both readable and writable.	API endpoint: - GET /trackings - GET /trackings/:id - DELETE /trackings/:id - POST /trackings - PUT /trackings/:id - POST /trackings/:id/mark-as-completed - POST /trackings/:id/retrack Tracking Webhook
New field proof_of_delivery added. Returns an array of proof of delivery (POD) records, such as a signature or photo captured upon successful delivery. This field returns a value only after the feature is enabled.	API endpoint: - GET /trackings - GET /trackings/:id - DELETE /trackings/:id - POST /trackings - PUT /trackings/:id - POST /trackings/:id/mark-as-completed - POST /trackings/:id/retrack Tracking Webhook
New field multi_piece_info added. Returns multi-piece shipment (MPS) metadata describing a group of packages that belong to the same shipment, including the piece type and the list of pieces. This field returns a value only when your subscription plan includes a multi-piece feature.	API endpoint: - GET /trackings - GET /trackings/:id - DELETE /trackings/:id - POST /trackings - PUT /trackings/:id - POST /trackings/:id/mark-as-completed - POST /trackings/:id/retrack Tracking Webhook
New field shipment_direction added. Indicates the business direction of the shipment: forward (outbound-to-customer) or return (customer-to-merchant). This field is both readable and writable.	API endpoint: - GET /trackings - GET /trackings/:id - DELETE /trackings/:id - POST /trackings - PUT /trackings/:id - POST /trackings/:id/mark-as-completed - POST /trackings/:id/retrack Tracking Webhook
New field return_shipment added. Returns the associated return shipment linked to the current outbound shipment when shipment_direction is forward and AfterShip has detected a linked return shipment. This field returns a value only after the feature is enabled.	API endpoint: - GET /trackings - GET /trackings/:id - DELETE /trackings/:id - POST /trackings - PUT /trackings/:id - POST /trackings/:id/mark-as-completed - POST /trackings/:id/retrack Tracking Webhook
New field forward_shipment added. Returns the original outbound shipment linked to this return when shipment_direction is return and AfterShip has detected a linked forward shipment. This field returns a value only after the feature is enabled.	API endpoint: - GET /trackings - GET /trackings/:id - DELETE /trackings/:id - POST /trackings - PUT /trackings/:id - POST /trackings/:id/mark-as-completed - POST /trackings/:id/retrack Tracking Webhook