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
REFERENCE
API Overview
Trackings
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
Get a tracking (Legacy)
get
Update a tracking (Legacy)
put
Delete a tracking (Legacy)
delete
Retrack an expired tracking (Legacy)
post
Mark tracking as completed (Legacy)
post
Couriers
Get user activated couriers
get
Detect courier
post
Get all couriers
get
Last Checkpoints
Get last checkpoint by tracking ID
get
Get last checkpoint (Legacy)
get
Notifications
Get tracking notification by tracking ID
get
Add a notification by tracking ID
post
Remove a notification by tracking ID
post
Get tracking notification (Legacy)
get
Add a notification (Legacy)
post
Remove a notification (Legacy)
post
Estimated delivery date
Batch prediction for the Estimated Delivery Date
post
MODEL
Tracking
Courier
Checkpoint
Notification
ENUM
Additional Tracking Fields
Delivery Statuses
Delivery Sub-statuses
Slug Groups
Events
Confidence Codes
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
Android SDK
iOS SDK
Java SDK
Node.js SDK
.NET SDK
Python SDK
Ruby Gem
PHP SDK
Golang SDK
Open Source
phone
email-verifier
Support
Contact Support

Versioning

Versioning helps the API users to smoothen the API upgrade process by providing a predictable new release and version deprecation schedule.

API users can manage their own system upgrade roadmap that fits their needs and no longer need to be bounded by the API version upgrade timeframe.

The API version is specified in the API endpoint URL. For AfterShip Tracking API, the URL would be:

preparing...

The version number follows a date-based format like YYYY-MM. For example, for the tracking resource in October 2023, the complete URL would be:

preparing...

To discover the exact API version serving your request, check the API response header field named as-api-version.

Header NameDescriptionFormat
as-api-versionThe actual API version that serves the request.YYYY-MM

2023-10 2024-01 2024-04 2024-07 and so on.

Expect a new version of the AfterShip Tracking API every quarter, released on the 2nd Thursday of the 1st month of that quarter. The table below provides the release dates for the next 6 versions:

VersionRelease DateSupported until
2023-102023-10-122025-04-09
2024-012024-01-112025-07-09
2024-042024-04-112025-10-08
2024-072024-07-112026-01-07
2024-102024-10-102026-04-08
2025-012025-01-092026-07-08

Every API version enjoys support for a minimum of approximately 18 months, ensuring that the first version remains supported until the day before the release of the seventh version. This provides developers with a substantial overlap of at least 15 months between two consecutive stable versions, allowing them ample time to complete their API upgrading process.

We strongly recommend updating your integration to the latest API version every quarter in order to use our latest features. If a request is made to an unsupported API version, it will automatically redirect to the oldest supported API version.

For example, if you make a request to the API version 2023-10 after 2025-04-09, the request will be served by the API version 2024-01 (the oldest supported version).

Version Support Schedule Chart

version_support_schedule_chart.png