Skip to navigation

Read a catalogue Variant

One of your variants: its availability, the active_revision new try-ons render, its latest_revision, and the generation a publish or retire must name. Another account’s variant, and one that does not exist, both answer 404 VARIANT_NOT_FOUND. 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.

Path parameters

variant_idstringRequired

Response

The variant
active_revisioninteger or null>=1
availabilityenum
Allowed values:
created_atdatetime
external_refstring or null
generationinteger>=1
gtinstring or null
idstring
kindenum
Allowed values:
latest_revisioninteger>=1
updated_atdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
503
Service Unavailable Error