Plans: Premium, Enterprise Platforms: All Platforms
Overview
AfterShip API is a shipment tracking API that returns tracking info of our supported carriers. You can insert tracking results directly at your application or store, and notify users of delivery updates using webhooks.
The AfterShip API is implemented as JSON over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Tracking or Carrier, has its own URL and is manipulated in isolation. In other words, we've tried to make the API follow the REST principles as much as possible.
Documentation
Please find the complete AfterShip API documentation here.
Get API Key
Log in to your AfterShip Tracking account.
Navigate to Settings > API keys.
Click Create API key and follow the given instructions to generate your API key.
Existing API keys do not need to be regenerated when upgrading plans or enabling new carrier tracking features (e.g., Royal Mail). Your existing API key will automatically work for newly enabled features.
Simply having an API key does not mean the API is actively in use. Ensure your systems are configured to make API calls or use webhooks to leverage the key effectively.
How API Keys Work
API keys are essential for authenticating requests to AfterShip's API endpoints. They enable various functionalities, including shipping tracking and feature enablement. However, the presence of an API key in your account does not automatically mean the API is in use. Systems must actively call the API or use webhooks to utilize the key effectively.
If you have any queries, feel free to connect with our support team for quick assistance.