Skip to navigation
API referenceCatalogue

List your catalogue Variants

Your variants, newest first: (created_at, id) descending. external_ref narrows the list to that SKU. Pages are chained with next_cursor, opaque and bound to this query’s filters and to you: send it back with the same filters, or the answer is 400 INVALID_CURSOR. An unknown or repeated parameter is 400 INVALID_REQUEST naming it. Requires the catalogue.read scope, which your account operator provisions; no other catalogue scope implies it. Served only where the catalogue is enabled for your environment.

Authentication

X-API-Keystring

API key for one environment of your account. Keep server-side; never expose in browser clients.

Query parameters

limitstring or nullOptional

Page size, an integer 1-100 (default 20).

cursorstring or nullOptional

next_cursor of the previous page.

external_refstring or nullOptional

Only the variants carrying this external_ref: at most one not retired, and the retired ones before it.

gtinstring or nullOptional
Only the variants carrying this GS1 barcode, exactly as written.
kindstring or nullOptional

Only the makeup or only the hair shades.

Response

A page of the caller's variants, newest first
datalist of objects
has_moreboolean
next_cursorstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
503
Service Unavailable Error