The authentication header
Send your raw key in theX-Api-Client-Key header on every request:
lastUsedAt timestamp.
The key identifies both who you are and which merchant organization you operate on. You never
pass an organization ID — it is derived from the key.
Scopes
Each endpoint requires a specific scope. Your key is granted one or more:| Scope | Required by |
|---|---|
catalog:read | GET /attribute-templates, GET /products, GET /products/skus, GET /acceptance-rate |
catalog:submit | POST /products/submissions |
Responses to expect
No key was sent, or the key is invalid / inactive. Check the
X-Api-Client-Key header.Your key is valid but lacks the scope the endpoint requires. The body names the missing scope,
e.g.
Missing required scope: catalog:submit.The request itself is malformed — too many SKUs, an empty submission, a bad
modifiedSince value,
and so on. See each endpoint’s reference for specifics.