QUICKSTART
API Quick Start
Authentication
Rate Limit
Body Envelope
Request Errors
Try API Endpoints
CHANGELOG
Changelog
REFERENCE
API Overview
v4
Trackings
Get trackings
get
Create a tracking
post
Get a tracking
get
Update a tracking
put
Delete a tracking
delete
Retrack an expired tracking
post
Mark tracking as completed
post
Couriers
Get user activated couriers
get
Detect courier
post
Get all couriers
get
Last Checkpoints
Get last checkpoint
get
Notifications
Get tracking notification
get
Add a notification
post
Remove a notification
post
MODEL
Tracking
v4
Courier
v4
Checkpoint
v4
Notification
v4
ENUM
Additional Tracking Fields
Delivered Statuses
Delivered Sub-statuses
Slug Groups
Webhook
Webhook Overview
Webhook Specifications
Webhook Signature
Webhook Outgoing IPs
Webhook Changelog
OTHERS
Supported Couriers
CSV Upload & FTP Auto-Fetch
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

Authentication

Learn how to include an API-Key to authenticate your AfterShip API requests.

How to get your API Key?

Before you start using our REST API services, get your API key from your AfterShip account.

  1. Log in to your AfterShip account. If you don't already have one - SIGNUP. It's FREE
  2. Visit SETTINGS > API keys
  3. Give your API key a name and click Generate API Key

Request Header

All API calls must include this header to authenticate the usage of AfterShip API.

Replace your YOUR_API_KEY with your own key.

preparing...