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. Common scenarios

Scenario 1. Create store

Use POST API https://api.aftership.com/commerce/v1/stores

preparing...

Scenario 2. Get store

Use GET API https://api.aftership.com/commerce/v1/stores/{id}

preparing...

Scenario 3. Patch store

Use PATCH API https://api.aftership.com/commerce/v1/stores/{id}

preparing...

Scenario 4. Create order

Use POST API https://api.aftership.com/commerce/v1/orders

preparing...

Scenario 5. Get order

Use GET API https://api.aftership.com/commerce/v1/orders/{id}

preparing...

Scenario 6. Patch order

Use PATCH API https://api.aftership.com/commerce/v1/orders/{id}

preparing...

Scenario 7. Create product

Use POST API https://api.aftership.com/commerce/v1/products

preparing...

Scenario 8. Get product

Use GET API https://api.aftership.com/commerce/v1/products/{id}

preparing...

Scenario 9. Patch product

Use PATCH API https://api.aftership.com/commerce/v1/products/{id}

preparing...