Skip to navigation

Publish a catalogue Variant revision

Makes an approved revision the one new try-ons render. expected_generation is the generation you read; any other answers 409 GENERATION_CONFLICT and moves nothing. Publishing an earlier approved revision is rollback. A revision that is not approved answers 409 REVISION_NOT_APPROVED; a retired variant 409 VARIANT_RETIRED. Publishing the active revision at the current generation answers the variant unchanged. Send an Idempotency-Key: a retry with the same key and the same request answers the first response, byte for byte, with Idempotency-Replayed: true, so a response you did not receive is safe to retry. Requires the catalogue.publish 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

Headers

Idempotency-Keystring or nullOptional

Request

Make an approved revision the one new admissions render; rollback is a publish of an older approved revision.

expected_generationintegerRequired
revisionintegerRequired

Response

The variant, rendering the published revision
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
409
Conflict Error
503
Service Unavailable Error