Skip to main content

Base URL

Authentication

All endpoints require a Bearer token:
Retrieve your API key from the dashboard under Account > Developers.

Partial updates

PATCH endpoints change only the fields you send:
  • A field you leave out keeps its current value.
  • null or an empty string clears a field. Required fields, such as a name, can’t be cleared and return a 422.
  • An array or object you send replaces the stored value completely.
A few fields treat null differently: Send an empty list to remove all products from a group. Coupon and bundle offer items can’t be empty, unless the coupon is global. Patching a product leaves its variants alone. Use the variant endpoints under /products/{productId}/variants to add, change or remove them.
PUT update endpoints keep working, but some of them reset the fields you leave out. Use PATCH to change a few fields on a resource that has it.
Looking for the public API for resellers? See the Reseller API, which uses a different key and a separate set of endpoints.
Building your own customer area? See the Customer Dashboard API, which acts on behalf of a single customer using a token you mint with your API key.