QUICKSTART
API Quick Start
Authentication
SignString
OAuth
Overview
Getting Started
Scope List
Versioning
Rate Limit
Body Envelope
Request Errors
Try API Endpoints
CHANGELOG
Changelog
REFERENCE
API Overview
v4
Estimated delivery date
Batch prediction for the Estimated Delivery Date
post
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
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
Courier
Get user activated couriers
get
Detect courier
post
Get all couriers
get
Last Checkpoint
Get last checkpoint by tracking ID
get
Get last checkpoint (Legacy)
get
Notification
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
MODEL
Tracking
v4
Courier
v4
Checkpoint
v4
Notification
v4
ENUM
Additional Tracking Fields
Delivery Statuses
Delivery Sub-statuses
Slug Groups
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

Try API Endpoints

AfterShip API docs provide developers with an interactive interface to test the various endpoints. You can try our API on our public Postman workspace as well.


Our API documentation comes with an interactive API Playground where you can apply your API key and make real API requests directly.

We've also provided Postman request collection below.

Import Postman Collection From Link https://www.getpostman.com/collections/803197dd7b9e636c4b26

Your can try our API on our public Postman workspace as well https://www.postman.com/aftership

  1. Get an API key

  2. Import the Postman collection through the URL postman-import

  3. Configurate the AfterShip API Key through the environment variable. The default key is aftership-api-key postman-configurate-api-key

  4. Optionally you can adjust the base URL or use a different API key variable by editing the collection. postman-edit-collection

Most endpoints require existing data to be able to return something useful. We suggest you start by adding a couple of tracking and attach some notifications receivers to it.