Template Docs Commerce APIs Webhooks Custom Code Upcoming Changes
Get Started
Template Docs Commerce APIs Webhooks Custom Code Upcoming Changes
Get Started
Getting started
Overview Authentication and permissions Making requests Retrieve basic site information
Using Commerce APIs
Idempotency-Key header Rate limits Responses & error handling Upgrade Changelog Glossary FAQ
Inventory API
Overview GET: Retrieve all inventory GET: Retrieve specific inventory POST: Adjust stock quantities
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
Overview GET: Retrieve all profiles GET: Retrieve specific profiles
Transactions API
Overview GET: Retrieve all transactions GET: Retrieve specific transactions
Webhook Subscriptions API
Overview POST: Create a webhook subscription POST: Update a webhook subscription GET: Retrieve all webhook subscriptions GET: Retrieve a specific webhook subscription DEL: Delete a webhook subscription POST: Send test notification POST: Rotate a subscription secret

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.

Inventory API

Orders API