QUICKSTART
API Quick Start
Authentication
SignString
Versioning
Rate Limit
Body Envelope
Request Errors
Common Scenarios
Tracking
Sending Notifications
Estimated Delivery Date
Branded Tracking Page
Product Recommendation
Buy Online, Pickup In Store (BOPIS)
Next Couriers
Other Scenarios
Shipping
Returns
CHANGELOG
Changelog
Migration Guide
Past Changelog
REFERENCE
API Overview
Orders
Create an order
post
Get orders
get
Get order by ID
get
Update order by ID
patch
Create an order item
post
Get order item by ID
get
Update order item by ID
patch
Delete an order item
delete
Products
Create a product
post
Get products
get
Get product by ID
get
Update product by ID
patch
Create a new product variant
post
Get variant by ID
get
Update product variant
patch
Delete product variant
delete
Stores
Create a store
post
Get stores
get
Get store by ID
get
Update store by ID
patch
Fulfillments
Create a fulfillment
post
Get fulfillments
get
Get fulfillment by ID
get
Update fulfillment by ID
patch
Update fulfillment status
post
Ship fulfillment
post
Model
Envelope
Meta
v1
Error
v1
Pagination
v2
Primitive
Address
v1
AddressWithCoordinate
v1
Customer
v1
Location
v1
Money
v1
OpeningHours
v1
OpeningHourPeriod
v1
Pickup
v1
PickupLocation
v1
Tracking
v1
Weight
v1
OrderCustomFields
v1
StatusTimestamps
v1
Resource
Order
v1
OrderItem
v1
Product
v1
ProductVariant
v1
Fulfillment
v1
Store
v1
Support
Contact Support

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

preparing...

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 crucial as it must be included in the header of all subsequent API requests as as-store-id, allowing the system to identify which store context your operations should apply to.

Activating the store

After creating your store in Commerce API, please contact our support team or your customer success manager to configure and enable the specific Commerce API features you need (such as tracking, returns, etc.) for this store. This is a separate configuration from any AfterShip products you may have already subscribed to. When reaching out, provide the store.id you received in 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

Shipping

Returns