QUICKSTART
API Quick Start
Authentication
SignString
OAuth
Overview
Getting Started
Scope List
Versioning
Rate Limit
Body Envelope
Request Errors
Try API Endpoints
CHANGELOG
Changelog
Migration Guide
Past Changelog
REFERENCE
API Overview
Tracking
Get trackings
get
Create a tracking
post
Get a tracking by ID
get
Update a tracking by ID
put
Delete a tracking by ID
delete
Retrack an expired tracking by ID
post
Mark tracking as completed by ID
post
Courier
Get couriers
get
Detect courier
post
Courier connection
Get courier connections
get
Create courier connections
post
Get courier connection by id
get
Update courier connection by id
patch
Delete courier connection by id
delete
Estimated delivery date
Prediction for the Estimated Delivery Date
post
Batch prediction for the Estimated Delivery Date
post
MODEL
Tracking
Courier
Checkpoint
Courier Connection
ENUM
Additional Tracking Fields
Delivery Statuses
Delivery Sub-statuses
Slug Groups
Events
Confidence Codes
AfterShip EDD Revise Reasons
Webhook
Webhook Overview
Webhook Versioning
Webhook Specifications
Webhook Signature
Webhook OAuth 2.0
Webhook Outgoing IPs
Webhook Changelog
OTHERS
Supported Couriers
CSV Upload & CSV Auto-Fetch
Shipment CSV Export
Order CSV Export
SDK
Java SDK
Node.js SDK
.NET SDK
Python SDK
Ruby Gem
PHP SDK
Golang SDK
Open Source
phone
email-verifier
Support
Contact Support

Changelog

2025-04 (2025-04-10)

ChangeBeforeAfter
Base URLhttps://api.aftership.com/tracking/2025-01https://api.aftership.com/tracking/2025-04
as-api-version header’s value2025-012025-04
ChangeAffected Endpoints
New fields in Tracking model:
latest_estimated_delivery.revise_reason		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
The length of the tracking ID has been updated from a 32-character string to a string ranging from 0 to 128 charactersAPI 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
The existing fields will be deprecated:
- tracking_origin_country_region
- tracking_destination_country_region
- tracking_postal_code
- tracking_state		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 fields in Courier model:
- active
- credentials
- credentials.fields
- credentials.fields.*.name
- credentials.fields.*.type
- credentials.fields.*.required		API endpoint:
- GET /couriers
- POST /couriers/detect
- Rename courier.required_fields enum value - tracking_origin_country_region to origin_country_region
- Rename courier.required_fields enum value - tracking_destination_country_region to destination_country_region
- Rename courier.required_fields enum value - tracking_postal_code to destination_postal_code
- Rename courier.required_fields enum value - tracking_state to destination_state
API endpoint:
- GET /couriers
- POST /couriers/detect
New parameters in GET /couriers endpoint:
- active
- slug		API endpoint:
- GET /couriers
New API ednpoints:
- GET /courier-connections
- POST /courier-connections
- PATCH /courier-connections/:id
- DELETE /courier-connections/:id
- GET /courier-connections/:id		-
API ednpoints deprecation:
- GET /couriers/all		API endpoint:
- GET /couriers/all