API Quick Start
This quickstart guide intends to walk you through the common scenario to help you know how to use the AfterShip Commerce API.
1. What is Commerce API?
Commerce API is a collection of eCommerce functionality exposed via API. It provides access to core capabilities that are commonly used in Stores, Products, Orders, and other eCommerce activities.
2. API Endpoint
All endpoints are only accessible via HTTPS.
3. Generate an API Key
AfterShip verifies a user's request by adding an as-api-key in the header.
To get your API key, visit API key, click Create an API key and follow the given instructions to generate your API key.
Please visit here for the API authentication detail.
4. Create a Store
In the Commerce API, a store represents your actual retail outlet or an online store. All other resources within the API, including orders and products, are linked to a specific store.
Therefore, before you can utilize any features of the Commerce API, you must first create a store. After the store has been created, you will obtain a store ID. This ID is necessary for creating subsequent resources within the API.
Activating the store
Please contact the support team or your customer success manager to activate the connection between your store and AfterShip products. Please provide the store ID from the previous step.
5. Common Scenarios
You can utilize the Commerce API in various ways, depending on your specific usage scenarios. Please visit the links below for quick-start tutorials tailored to different use cases:
Tracking
- Introduction
- Sending Notifications
- Estimated Delivery Date
- Branded Tracking Page
- Product Recommendation
- Buy Online, Pickup In Store (BOPIS)
- Next couriers
- Other Scenarios