Skip to navigation

Retire a catalogue Variant

Retires the variant at expected_generation (409 GENERATION_CONFLICT if it moved): a new try-on naming it is refused, it takes no new revision, and its external_ref is free for a new variant. Retiring is final (409 VARIANT_RETIRED after). A job already admitted from the variant still replays what it was admitted as. 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

Retire the variant for good; it frees its external_ref.

expected_generationintegerRequired

Response

The variant, retired
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