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

Available Scopes

Scope codeAvailable API Endpoint
aftership:tracking:readGET /trackings
GET /trackings/:slug/:tracking_number
GET /trackings/:trackingID
aftership:tracking:writePOST /trackings
PUT /trackings/:slug/:tracking_number
PUT /trackings/:trackingID
DELETE /trackings/:slug/:tracking_number
DELETE /trackings/:trackingID
POST /trackings/:slug/:tracking_number/retrack
POST /trackings/:trackingID/retrack
POST /trackings/:slug/:tracking_number/mark-as-completed
POST /trackings/:trackingID/mark-as-completed
aftership:courier:readGET /couriers
GET /couriers/all
aftership:courier:writePOST /couriers/detect
aftership:last_checkpoint:readGET /last_checkpoint/:slug/:tracking_number
GET /last_checkpoint/:trackingID
aftership:notification:readGET /notifications/:slug/:tracking_number
GET /notifications/:trackingID
aftership:notification:writePOST /notifications/:slug/:tracking_number/add
POST /notifications/:trackingID/add
POST /notifications/:slug/:tracking_number/remove
POST /notifications/:trackingID/remove
aftership:estimated_delivery_date:writePOST /estimated-delivery-date/predict-batch