Getting started
Using Commerce APIs
Inventory API
Orders API
Overview
POST: Create an order
POST: Fulfill an order
GET: Retrieve all orders
GET: Retrieve a specific order
Products API
Overview
About product attributes
Managing attributes
POST: Create a product
POST: Create a product variant
POST: Upload a product image
GET: Retrieve all Store Pages
GET: Retrieve all products
GET: Retrieve specific products
GET: Product image upload status
POST: Assign a product image to variant
POST: Reorder a product image
POST: Update a product
POST: Update a product variant
POST: Update a product image
DEL: Delete a product
DEL: Delete a product variant
DEL: Delete a product image
Profiles API
Transactions API
Webhook Subscriptions API
Idempotency-Key header
Certain requests should only occur once in an event of a client, server, or network error.
For example, adjusting the stock quantity for an item.
That's why some Commerce API endpoints require an Idempotency-Key header.
By using the same Idempotency-Key and parameters,
a request may be retried multiple times though it will only be executed on the first successful attempt.
Every subsequent request receives the same response.
Specifications
- A unique string consisting of up to 64 alphanumeric characters, dashes, and underscores; UUIDs are valid and common.
- Keys are recycled after an unspecified interval, however, they're guaranteed effective for 48 hours from the time they're used successfully.
Endpoints
The Commerce API endpoints listed below require an Idempotency-Key header.