{"openapi":"3.1.1","info":{"title":"CodePersist Customer API","description":"The customer API is available on Lite and Premium. Saving creates an immutable version. Publish that version separately to make it live.\n\nSend exactly one `Authorization` HTTP request header using `Authorization: Bearer YOUR_API_KEY`. Replace `YOUR_API_KEY` with your API key. Use a read/write key for operations marked Write access.\n\nSend a UTF-8 JSON request body with the `Content-Type` request header set to `application/json` or a supported `application/*+json` media type.\n\nUse the exact documented camelCase property and query names. Unknown or duplicate JSON properties and unknown, repeated or empty query parameters return 400. JSON numbers must be number tokens, not quoted strings; booleans must be true or false. Required members must be present, including nullable members. Non-null fields and array elements cannot be null. UUID inputs use the 36-character hyphenated form, accept either hexadecimal letter case and cannot be all zeroes. JSON request bodies are limited to 256 KiB; oversized bodies return 413 and unsupported content types return 415. Operations without a request body reject supplied content.","version":"v1"},"servers":[{"url":"https://api.codepersist.com"}],"paths":{"/api/v1/products":{"get":{"tags":["Products"],"summary":"List products","description":"Read-only access. Browse your product catalog. Use the `gtin` query parameter to filter by barcode number. If a create response was lost, compare the `resolverUrl` field of each matching product in the response body before creating again.\n\nSet the `limit` query parameter to change the page size. Copy `nextOffset` from the JSON response body into the next request’s `offset` query parameter and keep the same filter. A null `nextOffset` means you reached the end. Concurrent changes can shift results between pages.","operationId":"CustomerV1ListProducts","parameters":[{"name":"offset","in":"query","description":"Zero-based `offset` query parameter. Omit it or use 0 for the first page. Copy `nextOffset` from the previous JSON response body and keep the same filter. Allowed values are 0–2147483546 in ASCII decimal digits without a sign, whitespace, fraction or exponent.","schema":{"maximum":2147483546,"minimum":0,"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Maximum number of results per page, from 1 to 100. The `limit` query parameter defaults to 50 when omitted. A page can contain fewer results. Check `nextOffset` in the JSON response body for another page. Send ASCII decimal digits without a sign, whitespace, fraction or exponent.","schema":{"maximum":100,"minimum":1,"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","format":"int32","default":50}},{"name":"gtin","in":"query","description":"Filter by an exact barcode number. Use a valid GTIN-8, GTIN-12, GTIN-13 or GTIN-14 with a correct check digit. Surrounding whitespace is trimmed. Omit the parameter to list all GTINs. Empty values are rejected. To find one printed identity, compare the original `resolverUrl` as well.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionPageOfProductDocument"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]},"post":{"tags":["Products"],"summary":"Create a product","description":"Write access. Create the first saved version. In the JSON request body, supply `name`, a valid `gtin` and `destinationUrl`. If you omit the optional `resolverUrl`, `resources` and `barcode` fields, CodePersist uses its standard scan address, adds a product-page link from your destination and applies the default QR settings. Publish separately when the product is ready to go live.\n\nThe GTIN and original resolver are fixed at creation. A standard-resolver product can later gain one permanent custom domain. On HTTP 201, save `id` from the JSON response body. When publishing, copy the response body’s `currentVersion.id` into the publish request body’s `expectedVersionId`. The `Location` HTTP response header contains the relative path `/api/v1/products/{id}`. Send a GET to that path on the API host to read the new product. If the response is lost, list products using the `gtin` query parameter and compare the matching results’ `resolverUrl` fields before retrying.","operationId":"CustomerV1CreateProduct","requestBody":{"description":"Send a UTF-8 JSON request body with the `Content-Type` request header set to `application/json` or a supported `application/*+json` media type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductInput"},"example":{"name":"Ground coffee 250g","gtin":"09506000134352","destinationUrl":"https://brand.example/coffee"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateProductInput"},"example":{"name":"Ground coffee 250g","gtin":"09506000134352","destinationUrl":"https://brand.example/coffee"}}},"required":true},"responses":{"201":{"description":"Resource created. The `Location` response header points to the new resource.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Location":{"description":"The `Location` response header contains the relative path to the created resource. Resolve it against the API host and use GET with your `Authorization` request header.","schema":{"type":"string","format":"uri-reference"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDocument"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"413":{"description":"The JSON request body exceeds 256 KiB.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"415":{"description":"Set the `Content-Type` request header to `application/json` or a supported `application/*+json` media type and send a UTF-8 JSON body.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}},"/api/v1/products/{id}":{"get":{"tags":["Products"],"summary":"Get a product","description":"Read-only access. Read the product before editing, publishing, generating QR artwork or acting on a disable operation. Put the product ID in the `id` path parameter. The JSON response body includes the latest saved configuration and the product’s publication and disable state.\n\nIn the JSON response body, `currentVersion.id` identifies the saved configuration, `publishedVersionId` identifies the last published version, and `removalOperationId` identifies a disable attempt. The saved and published versions can differ after an edit. An unavailable product returns HTTP 404.","operationId":"CustomerV1GetProduct","parameters":[{"name":"id","in":"path","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}}],"responses":{"200":{"description":"OK","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDocument"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]},"put":{"tags":["Products"],"summary":"Replace product configuration","description":"Write access. Put the product ID in the `id` path parameter. Read the product and start with the `name`, `resources` and `barcode` fields from the response body’s `currentVersion` object. Include those fields in the JSON request body, even if you change only the name. This replaces the full editable configuration.\n\nCopy the reviewed `currentVersion.id` from the product response body into `expectedVersionId` in the request body. On HTTP 409, reread the product and reconcile the changes. Saving creates a version and preserves the GTIN, original resolver and any attached domain. Publish separately to update what scans return.","operationId":"CustomerV1ReplaceProduct","parameters":[{"name":"id","in":"path","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}}],"requestBody":{"description":"Send a UTF-8 JSON request body with the `Content-Type` request header set to `application/json` or a supported `application/*+json` media type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceProductInput"},"example":{"expectedVersionId":"11111111-1111-1111-1111-111111111111","name":"Ground coffee 250 g","resources":{"defaultLinkId":"product-page","slots":[],"links":[{"id":"product-page","slotKey":null,"url":"https://brand.example/coffee","relations":["https://ref.gs1.org/voc/pip"],"title":"Product information","mediaType":null,"languages":[],"context":[]}],"allowAdditionalRelations":true,"hostedLandingPageEnabled":false},"barcode":{"errorCorrection":"H","xDimensionMillimetres":0.6}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ReplaceProductInput"},"example":{"expectedVersionId":"11111111-1111-1111-1111-111111111111","name":"Ground coffee 250 g","resources":{"defaultLinkId":"product-page","slots":[],"links":[{"id":"product-page","slotKey":null,"url":"https://brand.example/coffee","relations":["https://ref.gs1.org/voc/pip"],"title":"Product information","mediaType":null,"languages":[],"context":[]}],"allowAdditionalRelations":true,"hostedLandingPageEnabled":false},"barcode":{"errorCorrection":"H","xDimensionMillimetres":0.6}}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDocument"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"413":{"description":"The JSON request body exceeds 256 KiB.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"415":{"description":"Set the `Content-Type` request header to `application/json` or a supported `application/*+json` media type and send a UTF-8 JSON body.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]},"delete":{"tags":["Products"],"summary":"Delete a disabled product","description":"Write access. Permanently remove a product once its disable operation has finished. Read the disabled product first. Put its ID in the `id` path parameter. Copy `currentVersion.id` and `removalOperationId` from the product response body into the `expectedVersionId` and `expectedRemovalOperationId` query parameters, respectively. Send no request body.\n\nHTTP 204 has no response body and also covers products already absent. A changed version or disable operation returns HTTP 409. If the response is lost or deletion cannot be confirmed (HTTP 503), check whether the product still exists before retrying.","operationId":"CustomerV1DeleteProduct","parameters":[{"name":"id","in":"path","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}},{"name":"expectedVersionId","in":"query","description":"Copy `currentVersion.id` from the latest product JSON response body after reviewing its configuration. It confirms the version you are acting on. If the current version changed, reread the product after HTTP 409 and review it before retrying. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}},{"name":"expectedRemovalOperationId","in":"query","description":"Copy the `removalOperationId` field from the latest product JSON response body. Enabling or deleting requires a completed disable attempt. Retrying requires a failed attempt. Check the response body’s `status` field to confirm its state. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}}],"responses":{"204":{"description":"No response body.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Deletion could not be confirmed. Read the product before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}},"/api/v1/products/{id}/custom-domain":{"post":{"tags":["Products"],"summary":"Attach a custom domain to a product","description":"Write access. Add a permanent custom scan address to an enabled product created with the CodePersist resolver. Connect, verify and activate the domain in CodePersist first. Put the product ID in the `id` path parameter. In the JSON request body, send the exact HTTPS origin as `resolverUrl` and copy `currentVersion.id` from the product response body into `expectedVersionId`. Each product can have one permanent attachment.\n\nThe JSON response body contains the updated product, including its new `currentVersion` and `digitalLinkUrl`. Previews use that URL immediately. Publish the version to update both scan addresses, then generate new print artwork. The original `resolverUrl` field and previously printed codes keep their addresses. Reread the product if the response is uncertain. An unavailable domain or existing attachment returns HTTP 400. A stale version or blocked product state returns HTTP 409.","operationId":"CustomerV1AttachCustomDomain","parameters":[{"name":"id","in":"path","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}}],"requestBody":{"description":"Send a UTF-8 JSON request body with the `Content-Type` request header set to `application/json` or a supported `application/*+json` media type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachCustomDomainInput"},"example":{"expectedVersionId":"11111111-1111-1111-1111-111111111111","resolverUrl":"https://id.brand.example/"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/AttachCustomDomainInput"},"example":{"expectedVersionId":"11111111-1111-1111-1111-111111111111","resolverUrl":"https://id.brand.example/"}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDocument"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"413":{"description":"The JSON request body exceeds 256 KiB.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"415":{"description":"Set the `Content-Type` request header to `application/json` or a supported `application/*+json` media type and send a UTF-8 JSON body.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}},"/api/v1/products/{id}/versions":{"get":{"tags":["Products"],"summary":"List product versions","description":"Read-only access. Put the product ID in the `id` path parameter to browse saved configurations from newest to oldest. The JSON response body lists versions in `items`. Each version includes the product name, scan destinations and QR settings as saved.\n\nUse the response field `items[].number` as the `number` path parameter when restoring. Compare the version’s `id` in `items` with `publishedVersionId` from the product response body to identify the last published version. Copy the response body’s `nextOffset` into the next call’s `offset` query parameter to continue. Use the `limit` query parameter to change the page size.","operationId":"CustomerV1ListVersions","parameters":[{"name":"id","in":"path","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}},{"name":"offset","in":"query","description":"Zero-based `offset` query parameter. Omit it or use 0 for the first page. Copy `nextOffset` from the previous JSON response body and keep the same filter. Allowed values are 0–2147483546 in ASCII decimal digits without a sign, whitespace, fraction or exponent.","schema":{"maximum":2147483546,"minimum":0,"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Maximum number of results per page, from 1 to 100. The `limit` query parameter defaults to 50 when omitted. A page can contain fewer results. Check `nextOffset` in the JSON response body for another page. Send ASCII decimal digits without a sign, whitespace, fraction or exponent.","schema":{"maximum":100,"minimum":1,"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"OK","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionPageOfVersionDocument"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}},"/api/v1/products/{id}/versions/{number}/restore":{"post":{"tags":["Products"],"summary":"Restore a product version","description":"Write access. Copy an earlier configuration into a new current version. Use the product ID as the `id` path parameter and the saved version’s `number` field as the `number` path parameter. In the JSON request body, set `expectedVersionId` to `currentVersion.id` from the latest product response body to confirm the state you are replacing.\n\nThe original scan identity and any permanent custom domain are preserved. Review the `currentVersion` object in the JSON response body and publish it separately. On HTTP 409, read the product again before attempting the restore.","operationId":"CustomerV1RestoreVersion","parameters":[{"name":"id","in":"path","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}},{"name":"number","in":"path","description":"The `number` path parameter selects a historical entry. Copy it from the version list response body’s `items[].number` field. In the JSON request body, supply `expectedVersionId` separately. The path accepts 1–9223372036854775807 in ASCII decimal digits without a sign, whitespace, fraction or exponent.","required":true,"schema":{"maximum":9223372036854775807,"minimum":1,"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","format":"int64"}}],"requestBody":{"description":"Send a UTF-8 JSON request body with the `Content-Type` request header set to `application/json` or a supported `application/*+json` media type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionInput"},"example":{"expectedVersionId":"11111111-1111-1111-1111-111111111111"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/VersionInput"},"example":{"expectedVersionId":"11111111-1111-1111-1111-111111111111"}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDocument"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"413":{"description":"The JSON request body exceeds 256 KiB.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"415":{"description":"Set the `Content-Type` request header to `application/json` or a supported `application/*+json` media type and send a UTF-8 JSON body.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}},"/api/v1/products/{id}/publications":{"get":{"tags":["Products"],"summary":"List publication attempts","description":"Read-only access. Put the product ID in the `id` path parameter to review its publication attempts from newest to oldest. The JSON response body includes the version, outcome, and start or completion time of each attempt.\n\nA successful attempt may refer to an older version. Compare `items[].versionId` from this response body with `currentVersion.id` and `publishedVersionId` from the product response body. Copy `nextOffset` from the response body into the next call’s `offset` query parameter when another page is available. Use the `limit` query parameter to change the page size.","operationId":"CustomerV1ListPublications","parameters":[{"name":"id","in":"path","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}},{"name":"offset","in":"query","description":"Zero-based `offset` query parameter. Omit it or use 0 for the first page. Copy `nextOffset` from the previous JSON response body and keep the same filter. Allowed values are 0–2147483546 in ASCII decimal digits without a sign, whitespace, fraction or exponent.","schema":{"maximum":2147483546,"minimum":0,"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Maximum number of results per page, from 1 to 100. The `limit` query parameter defaults to 50 when omitted. A page can contain fewer results. Check `nextOffset` in the JSON response body for another page. Send ASCII decimal digits without a sign, whitespace, fraction or exponent.","schema":{"maximum":100,"minimum":1,"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"OK","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionPageOfPublicationDocument"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]},"post":{"tags":["Products"],"summary":"Publish a product","description":"Write access. Make the saved version available to people who scan the QR code. Put the product ID in the `id` path parameter. Copy the product response body’s `currentVersion.id` into `expectedVersionId` in the JSON request body after reviewing the version. Publication updates the original scan address and any permanent custom-domain attachment.\n\nIn the JSON response body, compare `publishedVersionId` with the version you intended to publish. If the request times out or has an uncertain outcome, read the product and its publication history before retrying. Recovery can still finish accepted work.","operationId":"CustomerV1PublishProduct","parameters":[{"name":"id","in":"path","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}}],"requestBody":{"description":"Send a UTF-8 JSON request body with the `Content-Type` request header set to `application/json` or a supported `application/*+json` media type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionInput"},"example":{"expectedVersionId":"11111111-1111-1111-1111-111111111111"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/VersionInput"},"example":{"expectedVersionId":"11111111-1111-1111-1111-111111111111"}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDocument"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"413":{"description":"The JSON request body exceeds 256 KiB.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"415":{"description":"Set the `Content-Type` request header to `application/json` or a supported `application/*+json` media type and send a UTF-8 JSON body.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}},"/api/v1/products/{id}/disable":{"post":{"tags":["Products"],"summary":"Disable a product","description":"Write access. Take a product offline while retaining its configuration, history and artwork. Put the product ID in the `id` path parameter and send no request body. HTTP 202 confirms that removal was queued. Send a GET to the relative path in the `Location` response header to check progress.\n\nWait until the product response body’s `status` field is `disabled` before enabling or deleting it. If `status` is `disableFailed`, copy the response body’s `removalOperationId` into the retry request body’s `expectedRemovalOperationId` field. Plan and cooldown rules can block disabling.","operationId":"CustomerV1DisableProduct","parameters":[{"name":"id","in":"path","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}}],"responses":{"202":{"description":"Work accepted. Poll the product path in the `Location` response header to check progress.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Location":{"description":"The `Location` response header contains the relative product path. Send a GET to that path on the API host and check the `status` field in the JSON response body for progress.","schema":{"type":"string","format":"uri-reference"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDocument"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}},"/api/v1/products/{id}/enable":{"post":{"tags":["Products"],"summary":"Enable a disabled product","description":"Write access. Return a retained product to your enabled catalog. Put the product ID in the `id` path parameter. Wait for disabling to finish, then copy the product response body’s `removalOperationId` into `expectedRemovalOperationId` in the JSON request body. The product must fit within your current plan’s capacity.\n\nThe returned product’s JSON `status` field is `unpublished`. Review and publish its current version to restore scan access. On HTTP 409, check the latest removal state, operation ID and plan capacity before trying again.","operationId":"CustomerV1EnableProduct","parameters":[{"name":"id","in":"path","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}}],"requestBody":{"description":"Send a UTF-8 JSON request body with the `Content-Type` request header set to `application/json` or a supported `application/*+json` media type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemovalInput"},"example":{"expectedRemovalOperationId":"22222222-2222-2222-2222-222222222222"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RemovalInput"},"example":{"expectedRemovalOperationId":"22222222-2222-2222-2222-222222222222"}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDocument"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"413":{"description":"The JSON request body exceeds 256 KiB.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"415":{"description":"Set the `Content-Type` request header to `application/json` or a supported `application/*+json` media type and send a UTF-8 JSON body.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}},"/api/v1/products/{id}/disable/retry":{"post":{"tags":["Products"],"summary":"Retry failed product disabling","description":"Write access. Queue a fresh disable attempt after a failure. Put the product ID in the `id` path parameter. Read the product and confirm that its response body’s `status` field is `disableFailed`. Copy its `removalOperationId` field into `expectedRemovalOperationId` in the JSON request body.\n\nHTTP 202 accepts a new attempt. Send a GET to the path in the `Location` response header to poll it. Use the `removalOperationId` field from the latest product response body for later actions. If the failed attempt was replaced or the state changed, reread the product after HTTP 409.","operationId":"CustomerV1RetryDisable","parameters":[{"name":"id","in":"path","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}}],"requestBody":{"description":"Send a UTF-8 JSON request body with the `Content-Type` request header set to `application/json` or a supported `application/*+json` media type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemovalInput"},"example":{"expectedRemovalOperationId":"22222222-2222-2222-2222-222222222222"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RemovalInput"},"example":{"expectedRemovalOperationId":"22222222-2222-2222-2222-222222222222"}}},"required":true},"responses":{"202":{"description":"Work accepted. Poll the product path in the `Location` response header to check progress.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Location":{"description":"The `Location` response header contains the relative product path. Send a GET to that path on the API host and check the `status` field in the JSON response body for progress.","schema":{"type":"string","format":"uri-reference"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDocument"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"413":{"description":"The JSON request body exceeds 256 KiB.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"415":{"description":"Set the `Content-Type` request header to `application/json` or a supported `application/*+json` media type and send a UTF-8 JSON body.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}},"/api/v1/products/{id}/barcodes":{"get":{"tags":["Products"],"summary":"Generate production QR artwork","description":"Read-only access. Download the SVG for a published product using a read-only or read/write key. Pass the product ID in the path and its currentVersion.id as expectedVersionId in the query. The version must be current and published. Omit the optional label parameters to generate the base QR code.\n\nHTTP 200 returns the SVG attachment directly. Save the response body using the filename from the Content-Disposition response header. CodePersist does not retain the file or label values.","operationId":"CustomerV1GenerateBarcode","parameters":[{"name":"id","in":"path","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}},{"name":"expectedVersionId","in":"query","description":"Copy `currentVersion.id` from the latest product JSON response body after reviewing its configuration. It confirms the version you are acting on. If the current version changed, reread the product after HTTP 409 and review it before retrying. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","required":true,"schema":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}},{"name":"batchOrLot","in":"query","description":"Batch or lot identifier (GS1 AI 10), up to 20 supported GS1 characters. Send a string to preserve leading zeros.","schema":{"maxLength":20,"type":"string"}},{"name":"serialNumber","in":"query","description":"Serial number (GS1 AI 21), up to 20 supported GS1 characters. Send a string to preserve leading zeros.","schema":{"maxLength":20,"type":"string"}},{"name":"expirationDate","in":"query","description":"Expiration date (GS1 AI 17) as YYYY-MM-DD. The year must be within 49 years before to 50 years after the current UTC year.","schema":{"type":"string"}},{"name":"netWeightKilograms","in":"query","description":"Net weight in kilograms (GS1 AI 3103). Use a decimal point and a value from 0.001 to 999.999 in 0.001 kg increments.","schema":{"type":"string"}}],"responses":{"200":{"description":"The HTTP response body contains raw SVG bytes. The `Content-Type` response header is `image/svg+xml`.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"X-Content-SHA256":{"description":"The `X-Content-SHA256` response header contains the SHA-256 digest of the SVG response body as 64 lowercase hexadecimal characters.","schema":{"maxLength":64,"minLength":64,"pattern":"^[0-9a-f]{64}$","type":"string"}},"Content-Disposition":{"description":"The `Content-Disposition` response header provides the attachment filename for the SVG response body.","schema":{"type":"string"}}},"content":{"image/svg+xml":{"schema":{"$ref":"#/components/schemas/Stream"}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}},"/api/v1/products/batch/publish":{"post":{"tags":["Products"],"summary":"Publish multiple products","description":"Write access. Publish one to five products in one call. In the JSON request body’s `items` array, pair each `productId` with `expectedVersionId`, copied from the product response body’s `currentVersion.id` field. The service processes the selection in order.\n\nCheck each `items[].status` field in the JSON response body even when the HTTP status is 200. Earlier successes remain committed. Unavailable products get a per-item value of 404. If the response body’s `stopped` field is true, later items can have a status of 424. Read product state and publication history before resubmitting.","operationId":"CustomerV1BatchPublish","requestBody":{"description":"Send a UTF-8 JSON request body with the `Content-Type` request header set to `application/json` or a supported `application/*+json` media type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchPublishRequest"},"example":{"items":[{"productId":"33333333-3333-3333-3333-333333333333","expectedVersionId":"11111111-1111-1111-1111-111111111111"}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/BatchPublishRequest"},"example":{"items":[{"productId":"33333333-3333-3333-3333-333333333333","expectedVersionId":"11111111-1111-1111-1111-111111111111"}]}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchResult"},"example":{"items":[{"productId":"33333333-3333-3333-3333-333333333333","status":200,"code":null}],"stopped":false}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"413":{"description":"The JSON request body exceeds 256 KiB.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"415":{"description":"Set the `Content-Type` request header to `application/json` or a supported `application/*+json` media type and send a UTF-8 JSON body.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}},"/api/v1/products/batch/disable":{"post":{"tags":["Products"],"summary":"Disable multiple products","description":"Write access. Queue removal from the resolver for one to five distinct products. Put the product IDs in the `productIds` array of the JSON request body. If any product is unavailable, the entire request returns HTTP 404 before any changes begin.\n\nIn the JSON response body, `items[].status` of 202 means removal was accepted for that product. Poll the product endpoint until its JSON `status` field reports `disabled` or `disableFailed`. If the request ends unexpectedly, earlier changes may have been accepted. Reread all selected products before retrying.","operationId":"CustomerV1BatchDisable","requestBody":{"description":"Send a UTF-8 JSON request body with the `Content-Type` request header set to `application/json` or a supported `application/*+json` media type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchDisableRequest"},"example":{"productIds":["33333333-3333-3333-3333-333333333333"]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/BatchDisableRequest"},"example":{"productIds":["33333333-3333-3333-3333-333333333333"]}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchResult"},"example":{"items":[{"productId":"33333333-3333-3333-3333-333333333333","status":202,"code":null}],"stopped":false}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"413":{"description":"The JSON request body exceeds 256 KiB.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"415":{"description":"Set the `Content-Type` request header to `application/json` or a supported `application/*+json` media type and send a UTF-8 JSON body.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}},"/api/v1/products/batch/enable":{"post":{"tags":["Products"],"summary":"Enable multiple products","description":"Write access. Enable one to five products after their disable operations complete. In the JSON request body’s `items` array, pair each `productId` with `expectedRemovalOperationId`, copied from the product response body’s `removalOperationId` field. If any product is unavailable, the entire request returns HTTP 404 before any changes begin. Current plan capacity applies.\n\nCheck each `items[].status` field in the JSON response body. Products with a value of 200 are enabled as unpublished. Publish them to restore scan access. A failure can occur after earlier successes, so reread each selected product before retrying.","operationId":"CustomerV1BatchEnable","requestBody":{"description":"Send a UTF-8 JSON request body with the `Content-Type` request header set to `application/json` or a supported `application/*+json` media type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchEnableRequest"},"example":{"items":[{"productId":"33333333-3333-3333-3333-333333333333","expectedRemovalOperationId":"22222222-2222-2222-2222-222222222222"}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/BatchEnableRequest"},"example":{"items":[{"productId":"33333333-3333-3333-3333-333333333333","expectedRemovalOperationId":"22222222-2222-2222-2222-222222222222"}]}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchResult"},"example":{"items":[{"productId":"33333333-3333-3333-3333-333333333333","status":200,"code":null}],"stopped":false}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"413":{"description":"The JSON request body exceeds 256 KiB.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"415":{"description":"Set the `Content-Type` request header to `application/json` or a supported `application/*+json` media type and send a UTF-8 JSON body.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}},"/api/v1/products/batch/delete":{"post":{"tags":["Products"],"summary":"Delete multiple disabled products","description":"Write access. Permanently delete one to five fully disabled products. Each entry in the JSON request body’s `items` array must contain `productId`, `expectedVersionId` and `expectedRemovalOperationId`. Copy those values from the product response body’s `id`, `currentVersion.id` and `removalOperationId` fields. A changed version or disable operation can reject that item.\n\nCheck each `items[].status` field in the JSON response body. A value of 204 covers deleted or already absent products. Earlier deletions remain committed if a later item fails. If the response body’s `stopped` field is true, check current state before retrying uncertain items.","operationId":"CustomerV1BatchDelete","requestBody":{"description":"Send a UTF-8 JSON request body with the `Content-Type` request header set to `application/json` or a supported `application/*+json` media type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchDeleteRequest"},"example":{"items":[{"productId":"33333333-3333-3333-3333-333333333333","expectedVersionId":"11111111-1111-1111-1111-111111111111","expectedRemovalOperationId":"22222222-2222-2222-2222-222222222222"}]}},"application/*+json":{"schema":{"$ref":"#/components/schemas/BatchDeleteRequest"},"example":{"items":[{"productId":"33333333-3333-3333-3333-333333333333","expectedVersionId":"11111111-1111-1111-1111-111111111111","expectedRemovalOperationId":"22222222-2222-2222-2222-222222222222"}]}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchResult"},"example":{"items":[{"productId":"33333333-3333-3333-3333-333333333333","status":204,"code":null}],"stopped":false}}}},"400":{"description":"Invalid input. The Problem Details JSON response body may include a `code` field and an `errors` object keyed by input field.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"The API key in the `Authorization` request header is missing, invalid, expired or revoked. The response includes the `WWW-Authenticate` header.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The `WWW-Authenticate` response header is `Bearer` on HTTP 401. Send a valid API key in the `Authorization` request header.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"The API key lacks the required write permission, subscription or organisation access.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The resource is unavailable.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"The reviewed version or disable attempt changed, or a lifecycle or quota rule blocks the action. Read the product before retrying. A disable cooldown error can include `nextDisableAtUtc` in the Problem Details JSON response body, giving the next eligible time in UTC.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"413":{"description":"The JSON request body exceeds 256 KiB.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"415":{"description":"Set the `Content-Type` request header to `application/json` or a supported `application/*+json` media type and send a UTF-8 JSON body.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Organisation request budget exceeded. Wait the number of seconds in the `Retry-After` response header before retrying.","headers":{"X-Activity-Id":{"description":"The `X-Activity-Id` response header identifies this request. Share it with support when reporting a problem. When the response body includes a Problem Details `traceId` field, both values refer to the same request.","schema":{"type":"string"}},"Retry-After":{"description":"The `Retry-After` response header gives the number of seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[{"CustomerApiKey":[]}]}}},"components":{"schemas":{"AttachCustomDomainInput":{"title":"Custom domain request","required":["expectedVersionId","resolverUrl"],"type":"object","properties":{"expectedVersionId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Copy `currentVersion.id` from the latest product JSON response body after reviewing its configuration. It confirms the version you are acting on. If the current version changed, reread the product after HTTP 409 and review it before retrying. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"resolverUrl":{"type":"string","description":"Required, non-null HTTPS origin of an already-connected, verified and active custom domain. Use an ASCII hostname, including punycode where needed, with no user information, non-root path, query or fragment. The exact normalized origin, including its port, must match the connected domain. No domain ID is needed. Unlike creation, omission or null never selects a default.","format":"uri"}},"additionalProperties":false,"description":"JSON request body for attaching an already-connected active domain. Supply both `resolverUrl` and `expectedVersionId` as non-null fields. The updated product’s `currentVersion` in the JSON response body must be published separately to activate both addresses."},"BarcodeSettings":{"title":"QR code settings","type":"object","properties":{"errorCorrection":{"enum":["L","M","Q","H"],"type":"string","description":"Case-sensitive QR error correction string: L, M, Q or H. Omitted means M; null and numeric values are rejected.","default":"M"},"xDimensionMillimetres":{"multipleOf":0.001,"maximum":0.990,"minimum":0.396,"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$","type":"number","description":"QR module width as a JSON number, 0.396–0.990 millimetres in increments of 0.001. The value must be exactly representable as a decimal; excess precision is rejected rather than rounded. Exponents and trailing zeroes are accepted when exact. Omitted means 0.495; null and quoted numbers are rejected.","format":"double","default":0.495}},"additionalProperties":false,"description":"Digital Link QR settings. Production output is SVG; physical dimensions are in millimetres."},"BatchDeleteRequest":{"title":"Batch deletion request","required":["items"],"type":"object","properties":{"items":{"maxItems":5,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ProductDeletionSelection"},"description":"Supply one to five entries with distinct product IDs. Include each product only once, even if it has multiple versions or disable attempts. Invalid or duplicate selections return 400 before processing starts. Inspect the outcome for each selected product."}},"additionalProperties":false,"description":"JSON request body with one to five distinct products in the `items` array. For each entry, set `productId` and supply the reviewed version and completed disable attempt in `expectedVersionId` and `expectedRemovalOperationId`."},"BatchDisableRequest":{"title":"Batch disable request","required":["productIds"],"type":"object","properties":{"productIds":{"maxItems":5,"minItems":1,"uniqueItems":true,"type":"array","items":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Opaque identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"description":"Supply one to five entries with distinct product IDs. Include each product only once, even if it has multiple versions or disable attempts. Invalid or duplicate selections return 400 before processing starts. Inspect the outcome for each selected product."}},"additionalProperties":false,"description":"JSON request body with one to five distinct product IDs in the `productIds` array. Copy each ID from the `id` field of a product response."},"BatchEnableRequest":{"title":"Batch enable request","required":["items"],"type":"object","properties":{"items":{"maxItems":5,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ProductRemovalSelection"},"description":"Supply one to five entries with distinct product IDs. Include each product only once, even if it has multiple versions or disable attempts. Invalid or duplicate selections return 400 before processing starts. Inspect the outcome for each selected product."}},"additionalProperties":false,"description":"JSON request body with one to five distinct products in the `items` array. For each entry, set `productId` and copy `removalOperationId` from the product response body into `expectedRemovalOperationId`."},"BatchItemResult":{"title":"Result for one product","required":["productId","status"],"type":"object","properties":{"productId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"The product identifier from the submitted selection. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"status":{"pattern":"^-?(?:0|[1-9]\\d*)$","enum":[200,202,204,400,401,403,404,409,424,503],"type":"integer","description":"Per-product HTTP status meaning, independent of the outer HTTP 200 response. Inspect every item before considering the batch successful.","format":"int32"},"code":{"type":["null","string"],"description":"Optional stable, safe error code. No provider diagnostics or credentials are returned."}},"description":"A product outcome using HTTP status meanings: 200 enabled/published, 202 removal accepted, 204 deleted/absent, 400 invalid, 401 key no longer valid, 403 access denied, 404 not found, 409 conflict, 424 not attempted, or 503 uncertain failure."},"BatchPublishRequest":{"title":"Batch publication request","required":["items"],"type":"object","properties":{"items":{"maxItems":5,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ProductVersionSelection"},"description":"Supply one to five entries with distinct product IDs. Include each product only once, even if it has multiple versions or disable attempts. Invalid or duplicate selections return 400 before processing starts. Inspect the outcome for each selected product."}},"additionalProperties":false,"description":"JSON request body with one to five distinct products in the `items` array. For each entry, copy the product response body’s `id` into `productId` and `currentVersion.id` into `expectedVersionId`."},"BatchResult":{"title":"Batch results","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BatchItemResult"},"description":"Results in the JSON response body, one per product in request order. Match each item’s `productId` to the submitted product. Check the item’s `status` and `code` response fields before retrying."},"stopped":{"type":"boolean","description":"True when processing stopped before all submitted items could be confirmed. Read current state before retrying.","default":false}},"description":"JSON response body with one outcome per submitted product. HTTP 200 describes the batch request as a whole. Check each `items[].status` field and the `stopped` field in the response body. Successful items remain committed."},"CollectionPageOfProductDocument":{"title":"Page of products","required":["items","nextOffset"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductDocument"},"description":"Results in this JSON response body, in the endpoint’s documented order. If the response body’s `nextOffset` field is present and non-null, use it as the next request’s `offset` query parameter."},"nextOffset":{"minimum":0,"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer"],"description":"Copy this JSON response field into the `offset` query parameter to fetch the next page. Null marks the last page.","format":"int32"}},"description":"JSON response body with matching products in `items` and the next page position in `nextOffset`."},"CollectionPageOfPublicationDocument":{"title":"Page of publication attempts","required":["items","nextOffset"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicationDocument"},"description":"Results in this JSON response body, in the endpoint’s documented order. If the response body’s `nextOffset` field is present and non-null, use it as the next request’s `offset` query parameter."},"nextOffset":{"minimum":0,"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer"],"description":"Copy this JSON response field into the `offset` query parameter to fetch the next page. Null marks the last page.","format":"int32"}},"description":"JSON response body with publication attempts in `items`, newest first, and the next page position in `nextOffset`."},"CollectionPageOfVersionDocument":{"title":"Page of product versions","required":["items","nextOffset"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/VersionDocument"},"description":"Results in this JSON response body, in the endpoint’s documented order. If the response body’s `nextOffset` field is present and non-null, use it as the next request’s `offset` query parameter."},"nextOffset":{"minimum":0,"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer"],"description":"Copy this JSON response field into the `offset` query parameter to fetch the next page. Null marks the last page.","format":"int32"}},"description":"JSON response body with saved versions in `items`, newest first, and the next page position in `nextOffset`."},"CreateProductInput":{"title":"New product details","required":["name","gtin","destinationUrl"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name your team uses to recognise the product, such as Ground coffee 250 g. The service trims surrounding whitespace and requires 1–200 characters after trimming. Send the name when replacing a configuration even if it is unchanged."},"gtin":{"type":"string","description":"Global Trade Item Number from the product barcode. Send it as a string to keep leading zeros. The service accepts GTIN-8, GTIN-12, GTIN-13 and GTIN-14 in ASCII digits with a correct check digit, trims surrounding whitespace and returns the zero-padded 14-digit form. The GTIN is fixed after creation."},"destinationUrl":{"type":"string","description":"Address of the page or resource people should reach, for example `https://brand.example/coffee`. Supply an absolute HTTP or HTTPS URL with a host and without user information. The normalized URL can contain up to 2048 characters. Unicode destinations are supported.","format":"uri"},"resolverUrl":{"type":["null","string"],"description":"Original immutable HTTPS resolver origin with an ASCII hostname and no user information, non-root path, query or fragment. Use punycode for an internationalized hostname. A custom resolver must already be connected and available. Omitted or null on creation selects the configured default. This field remains unchanged if the custom-domain operation, app or Excel import later attaches a custom domain.","format":"uri"},"resources":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ResourceSet"}]},"barcode":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/BarcodeSettings"}]}},"additionalProperties":false,"description":"JSON request body for creating an unpublished product. The `name`, `gtin` and `destinationUrl` fields are required and non-null. Omit `resolverUrl` or set it to null to use the standard resolver. Omit `resources` or set it to null to create a standard link from `destinationUrl`. If supplied, the `resources` object controls the saved destinations. The `destinationUrl` field remains required and validated. Omit `barcode` or set it to null for the default QR settings."},"CustomerProductStatus":{"title":"Product status","enum":["unpublished","publishing","published","publishFailed","disabling","disabled","disableFailed"],"type":"string","description":"Lifecycle status in the product JSON response body’s `status` field. Compare it with `publishedVersionId` to distinguish the latest saved version from the last successful publication. After queuing removal, poll until `status` is `disabled` or `disableFailed`."},"CustomerPublicationStatus":{"title":"Publication attempt status","enum":["inProgress","succeeded","failed"],"type":"string","description":"The `status` field of a publication attempt in the JSON response body. A `succeeded` attempt applies to that entry’s `versionId`. Check the product response to see which version last went live."},"ProblemDetails":{"title":"API error details","type":"object","properties":{"type":{"type":["null","string"],"description":"URI identifying the problem category when supplied in the JSON response body."},"title":{"type":["null","string"],"description":"Short human-readable summary of the problem in the JSON response body."},"status":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"HTTP status repeated in the Problem Details JSON response body when supplied.","format":"int32"},"detail":{"type":["null","string"],"description":"Human-readable details about this occurrence of the problem, when provided in the JSON response body."},"instance":{"type":["null","string"],"description":"URI identifying this occurrence of the problem when supplied in the JSON response body."},"code":{"type":"string","description":"Stable error identifier in the Problem Details JSON response body when available. Use this field to distinguish specific errors within the same HTTP status."},"traceId":{"type":"string","description":"Request identifier in the Problem Details JSON response body. It matches the `X-Activity-Id` response header when both are present."},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Validation messages in the Problem Details JSON response body. Each key identifies a public input field and maps to an array of messages."}},"description":"JSON error response. Check the HTTP status first. When present, the body’s `code` field identifies the specific error, `errors` lists validation messages, and `traceId` correlates the request with the `X-Activity-Id` response header."},"ProductDeletionSelection":{"title":"Product selected for deletion","required":["productId","expectedVersionId","expectedRemovalOperationId"],"type":"object","properties":{"productId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"expectedVersionId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Copy `currentVersion.id` from the latest product JSON response body after reviewing its configuration. It confirms the version you are acting on. If the current version changed, reread the product after HTTP 409 and review it before retrying. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"expectedRemovalOperationId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Copy the `removalOperationId` field from the latest product JSON response body. Enabling or deleting requires a completed disable attempt. Retrying requires a failed attempt. Check the response body’s `status` field to confirm its state. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}},"additionalProperties":false,"description":"One object in the batch delete JSON request body’s `items` array. It identifies the product and confirms both the current version and the completed disable attempt."},"ProductDocument":{"title":"Product","required":["id","gtin","resolverUrl","digitalLinkUrl","status","currentVersion","publishedVersionId","publishedAtUtc","removalOperationId"],"type":"object","properties":{"id":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"The product identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"gtin":{"maxLength":14,"minLength":14,"pattern":"^[0-9]{14}$","type":"string","description":"Global Trade Item Number from the product barcode. Send it as a string to keep leading zeros. The service accepts GTIN-8, GTIN-12, GTIN-13 and GTIN-14 in ASCII digits with a correct check digit, trims surrounding whitespace and returns the zero-padded 14-digit form. The GTIN is fixed after creation."},"resolverUrl":{"type":"string","description":"Original immutable HTTPS resolver origin with an ASCII hostname and no user information, non-root path, query or fragment. Use punycode for an internationalized hostname. A custom resolver must already be connected and available. Omitted or null on creation selects the configured default. This field remains unchanged if the custom-domain operation, app or Excel import later attaches a custom domain.","format":"uri"},"digitalLinkUrl":{"type":"string","description":"The GS1 Digital Link URL encoded by the current saved version’s production artwork. It changes when the custom-domain operation, app or Excel import permanently attaches a custom domain to a default-resolver product; resolverUrl still identifies the original origin. New production artwork requires publication, which updates both addresses. Previously printed QR codes keep their original URL.","format":"uri"},"status":{"$ref":"#/components/schemas/CustomerProductStatus"},"currentVersion":{"$ref":"#/components/schemas/VersionDocument"},"publishedVersionId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":["null","string"],"description":"Identifier of the last successfully published version, or null if none. Compare this field with `currentVersion.id` in the same JSON response body to see whether the saved version has been published. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"publishedAtUtc":{"maxLength":27,"minLength":27,"pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{6}Z$","type":["null","string"],"description":"Last successful publication instant in UTC, formatted yyyy-MM-dd'T'HH:mm:ss.ffffff'Z' with six fractional digits; null when no version has been published. Not a request field.","format":"date-time","readOnly":true},"removalOperationId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":["null","string"],"description":"Identifier of the disable attempt in this JSON response body. Copy it into the `expectedRemovalOperationId` JSON request field when enabling or retrying, or into the `expectedRemovalOperationId` query parameter when deleting a single product. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}},"description":"JSON response body for a product. The `currentVersion` object holds its latest saved configuration. The `resolverUrl` field identifies its original scan origin, while the `digitalLinkUrl` field is the URL the current version encodes in artwork. Check `publishedVersionId` separately to see what last went live."},"ProductRemovalSelection":{"title":"Product selected for reactivation","required":["productId","expectedRemovalOperationId"],"type":"object","properties":{"productId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"expectedRemovalOperationId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Copy the `removalOperationId` field from the latest product JSON response body. Enabling or deleting requires a completed disable attempt. Retrying requires a failed attempt. Check the response body’s `status` field to confirm its state. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}},"additionalProperties":false,"description":"One object in the batch enable JSON request body’s `items` array. It identifies the product and the completed disable attempt."},"ProductVersionSelection":{"title":"Product and version to publish","required":["productId","expectedVersionId"],"type":"object","properties":{"productId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Copy the `id` field from the product JSON response body or the matching item in a list response. Use it in the `id` path parameter for a single product or in the batch request body. It is distinct from a GTIN, version ID or artwork ID. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"expectedVersionId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Copy `currentVersion.id` from the latest product JSON response body after reviewing its configuration. It confirms the version you are acting on. If the current version changed, reread the product after HTTP 409 and review it before retrying. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}},"additionalProperties":false,"description":"One object in the batch publish JSON request body’s `items` array. It identifies the product and the saved version to publish."},"PublicationDocument":{"title":"Publication attempt","required":["id","versionId","status","startedAtUtc","completedAtUtc"],"type":"object","properties":{"id":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"The publication attempt identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"versionId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"The product version this attempt publishes. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"status":{"$ref":"#/components/schemas/CustomerPublicationStatus"},"startedAtUtc":{"maxLength":27,"minLength":27,"pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{6}Z$","type":"string","description":"Server-assigned publication start instant in UTC, formatted yyyy-MM-dd'T'HH:mm:ss.ffffff'Z' with six fractional digits. Not a request field.","format":"date-time","readOnly":true},"completedAtUtc":{"maxLength":27,"minLength":27,"pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{6}Z$","type":["null","string"],"description":"Publication completion instant in UTC, formatted yyyy-MM-dd'T'HH:mm:ss.ffffff'Z' with six fractional digits; null while incomplete. Not a request field.","format":"date-time","readOnly":true}},"description":"One publication attempt. Provider details remain private; use the product to determine its currently published version."},"RemovalInput":{"title":"Disable operation to confirm","required":["expectedRemovalOperationId"],"type":"object","properties":{"expectedRemovalOperationId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Copy the `removalOperationId` field from the latest product JSON response body. Enabling or deleting requires a completed disable attempt. Retrying requires a failed attempt. Check the response body’s `status` field to confirm its state. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}},"additionalProperties":false,"description":"JSON request body containing the `expectedRemovalOperationId` field. Copy it from `removalOperationId` in the latest product response body. HTTP 409 means the operation ID or product state no longer permits the action."},"ReplaceProductInput":{"title":"Updated product configuration","required":["expectedVersionId","name","resources","barcode"],"type":"object","properties":{"expectedVersionId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Copy `currentVersion.id` from the latest product JSON response body after reviewing its configuration. It confirms the version you are acting on. If the current version changed, reread the product after HTTP 409 and review it before retrying. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"name":{"minLength":1,"type":"string","description":"Name your team uses to recognise the product, such as Ground coffee 250 g. The service trims surrounding whitespace and requires 1–200 characters after trimming. Send the name when replacing a configuration even if it is unchanged."},"resources":{"$ref":"#/components/schemas/ResourceSet"},"barcode":{"$ref":"#/components/schemas/BarcodeSettings"}},"additionalProperties":false,"description":"JSON request body that replaces all editable configuration and appends a version, even if values are unchanged. Copy `name`, `resources` and `barcode` from `currentVersion` in the product response body and apply your edits. Copy `currentVersion.id` into the request body’s `expectedVersionId` field."},"ResourceLink":{"title":"Scan destination link","required":["id","slotKey","url","relations","title","mediaType","languages","context"],"type":"object","properties":{"id":{"maxLength":100,"minLength":1,"pattern":"^[a-z0-9][a-z0-9-]{0,99}$(?![\\s\\S])","type":"string","description":"Stable local identifier. Non-null values use 1–100 lowercase ASCII letters, digits or hyphens, starting with a letter or digit; values are not trimmed."},"slotKey":{"maxLength":100,"minLength":1,"pattern":"^[a-z0-9][a-z0-9-]{0,99}$(?![\\s\\S])","type":["null","string"],"description":"Required member containing the key of this link's saved resource topic, or null for a link outside slots. Non-null values use 1–100 lowercase ASCII letters, digits or hyphens, starting with a letter or digit; values are not trimmed."},"url":{"type":"string","description":"Address of the page or resource people should reach, for example `https://brand.example/coffee`. Supply an absolute HTTP or HTTPS URL with a host and without user information. The normalized URL can contain up to 2048 characters. Unicode destinations are supported.","format":"uri"},"relations":{"maxItems":8,"minItems":1,"type":"array","items":{"type":"string","description":"Absolute HTTP or HTTPS relation URI with a host and no user information, at most 300 characters after normalization. Supported gs1: aliases expand to https://ref.gs1.org/voc/: pip, allergenInfo, ingredientsInfo, nutritionalInfo, instructions, certificationInfo, safetyInfo, quickStartGuide, tutorial, consumerHandlingStorageInfo, recallStatus, registerProduct, serviceInfo, support and verificationService. Alias names are case-sensitive. The exact GS1 defaultLink and defaultLinkMulti URIs are reserved. Fragments are significant; exact canonical duplicates are removed.","format":"uri"},"description":"Between one and eight descriptive relation URIs. Supported gs1: aliases are expanded and exact canonical duplicates are removed; fragments are significant."},"title":{"maxLength":200,"minLength":1,"type":"string","description":"Display text for this destination link. Supply nonblank text of up to 200 characters before trimming. The saved value omits surrounding whitespace."},"mediaType":{"type":["null","string"],"description":"Bare type/subtype, trimmed and stored in lowercase; no parameters or wildcards. Each component contains 1–127 characters, at most 255 overall. Type accepts ASCII letters, digits and underscore; subtype also accepts hyphen, plus and period. Slot hints are suggestions, with normalized duplicates removed. Required member; null means no media type is specified."},"languages":{"maxItems":8,"minItems":0,"type":"array","items":{"type":"string","description":"Trimmed two-letter language code with an optional two-letter region, for example en or en-CA; either letter case is accepted. Other language-tag forms are not supported."},"description":"Between zero and eight trimmed two-letter language codes, each optionally followed by a hyphen and two-letter region. Either letter case is accepted. Independent of the API caller's language."},"context":{"maxItems":8,"minItems":0,"type":"array","items":{"type":"string","description":"A context descriptor containing 1–100 characters after trimming; whitespace-only descriptors are rejected."},"description":"Between zero and eight context descriptors of 1–100 characters each after trimming. Preserve descriptors during replacement."}},"additionalProperties":false,"description":"One object in the `resources.links` array. In a JSON request body that supplies resources, include every link field. The `slotKey` and `mediaType` fields may be null. URI fragments in the `relations` array are significant."},"ResourceSet":{"title":"Scan destinations and rules","required":["defaultLinkId","slots","links","allowAdditionalRelations","hostedLandingPageEnabled"],"type":"object","properties":{"defaultLinkId":{"maxLength":100,"minLength":1,"pattern":"^[a-z0-9][a-z0-9-]{0,99}$(?![\\s\\S])","type":"string","description":"The id of the link used as the default scan destination; must identify a link in this resource set. Non-null values use 1–100 lowercase ASCII letters, digits or hyphens, starting with a letter or digit; values are not trimmed."},"slots":{"maxItems":16,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ResourceSlot"},"description":"Between zero and sixteen saved resource topics and their rules, with unique keys. Preserve the complete collection during replacement."},"links":{"maxItems":32,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ResourceLink"},"description":"Between one and thirty-two links with unique IDs, including the required product-page link. Preserve the complete collection during replacement."},"allowAdditionalRelations":{"type":"boolean","description":"Whether links may exist outside the saved slots; the required product-page link is always allowed. Required boolean with no default."},"hostedLandingPageEnabled":{"type":"boolean","description":"Whether scans display a hosted choice of the product's saved links."}},"additionalProperties":false,"description":"The `resources` object in a create or replace JSON request body and in a saved version response. Preserve the complete object when replacing a product. The `links` array must contain a link with `id` set to `product-page` and `relations` containing `https://ref.gs1.org/voc/pip`. Link IDs and slot keys must be unique. The `defaultLinkId` field must identify a configured link. Every link’s non-null `slotKey` must match a slot’s `key`, and the link’s `relations` array must contain that slot’s `relationUri`. The number of assigned links must fit the slot’s `minimumLinks` and `maximumLinks` fields."},"ResourceSlot":{"title":"Scan destination topic","required":["key","relationUri","label","minimumLinks","maximumLinks","mediaTypeHints"],"type":"object","properties":{"key":{"maxLength":100,"minLength":1,"pattern":"^[a-z0-9][a-z0-9-]{0,99}$(?![\\s\\S])","type":"string","description":"Stable local identifier. Non-null values use 1–100 lowercase ASCII letters, digits or hyphens, starting with a letter or digit; values are not trimmed."},"relationUri":{"type":"string","description":"Absolute HTTP or HTTPS relation URI with a host and no user information, at most 300 characters after normalization. Supported gs1: aliases expand to https://ref.gs1.org/voc/: pip, allergenInfo, ingredientsInfo, nutritionalInfo, instructions, certificationInfo, safetyInfo, quickStartGuide, tutorial, consumerHandlingStorageInfo, recallStatus, registerProduct, serviceInfo, support and verificationService. Alias names are case-sensitive. The exact GS1 defaultLink and defaultLinkMulti URIs are reserved. Fragments are significant; exact canonical duplicates are removed.","format":"uri"},"label":{"maxLength":100,"minLength":1,"type":"string","description":"Nonblank text with at most 100 characters before trimming. Stored without surrounding whitespace."},"minimumLinks":{"maximum":4,"minimum":0,"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","description":"Integer literal from 0 to 4, without a decimal point or exponent. minimumLinks must not exceed maximumLinks, and the number of links assigned to the slot must fall within both bounds.","format":"int32"},"maximumLinks":{"maximum":4,"minimum":0,"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","description":"Integer literal from 0 to 4, without a decimal point or exponent. minimumLinks must not exceed maximumLinks, and the number of links assigned to the slot must fall within both bounds.","format":"int32"},"mediaTypeHints":{"maxItems":8,"minItems":0,"type":"array","items":{"type":"string","description":"Bare type/subtype, trimmed and stored in lowercase; no parameters or wildcards. Each component contains 1–127 characters, at most 255 overall. Type accepts ASCII letters, digits and underscore; subtype also accepts hyphen, plus and period. Slot hints are suggestions, with normalized duplicates removed."},"description":"Between zero and eight bare media-type suggestions. Normalized duplicates are removed. Links are not required to use one of the suggestions."}},"additionalProperties":false,"description":"A resource topic and the link rules saved with this product version. Preserve these rules when editing links."},"Stream":{"title":"SVG image","type":"string","description":"Raw SVG bytes in the HTTP response body, with `image/svg+xml` in the `Content-Type` response header.","format":"binary"},"VersionDocument":{"title":"Saved product version","required":["id","number","name","resources","barcode","basedOnVersionId","createdAtUtc"],"type":"object","properties":{"id":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"The immutable product version identifier. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"number":{"maximum":9223372036854775807,"minimum":1,"pattern":"^-?(?:0|[1-9]\\d*)$","type":"integer","description":"Version number in the version JSON response. Copy this field into the restore endpoint’s `number` path parameter to select the source configuration. Use `currentVersion.id` from the product response body for `expectedVersionId` in the restore request body.","format":"int64"},"name":{"maxLength":200,"minLength":1,"type":"string","description":"Name your team uses to recognise the product, such as Ground coffee 250 g. The service trims surrounding whitespace and requires 1–200 characters after trimming. Send the name when replacing a configuration even if it is unchanged."},"resources":{"$ref":"#/components/schemas/ResourceSet"},"barcode":{"$ref":"#/components/schemas/BarcodeSettings"},"basedOnVersionId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":["null","string"],"description":"The historical source copied by a restore, when applicable. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"},"createdAtUtc":{"maxLength":27,"minLength":27,"pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{6}Z$","type":"string","description":"Server-assigned version creation instant in UTC, formatted yyyy-MM-dd'T'HH:mm:ss.ffffff'Z' with six fractional digits. Not a request field.","format":"date-time","readOnly":true}},"description":"One saved product configuration. In the product JSON response body it appears in `currentVersion`; in version history it appears in `items`. Use the current version’s `id` when supplying `expectedVersionId`. Use the historical `number` as the `number` path parameter when restoring."},"VersionInput":{"title":"Current version to confirm","required":["expectedVersionId"],"type":"object","properties":{"expectedVersionId":{"maxLength":36,"minLength":36,"pattern":"^(?!00000000-0000-0000-0000-000000000000$)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string","description":"Copy `currentVersion.id` from the latest product JSON response body after reviewing its configuration. It confirms the version you are acting on. If the current version changed, reread the product after HTTP 409 and review it before retrying. A nonzero UUID in hyphenated 36-character form; input hexadecimal letters may use either case. Responses use lowercase.","format":"uuid"}},"additionalProperties":false,"description":"JSON request body containing the `expectedVersionId` field. Copy its value from `currentVersion.id` in the latest product response body. A changed version is rejected with HTTP 409."}},"securitySchemes":{"CustomerApiKey":{"type":"http","description":"Send exactly one `Authorization` HTTP request header using `Authorization: Bearer YOUR_API_KEY`. Replace `YOUR_API_KEY` with your API key. Use a read/write key for operations marked Write access.","scheme":"bearer","bearerFormat":"CodePersist API key"}}},"tags":[{"name":"Products"}]}