{ "item": [ { "name": "v1", "description": "", "item": [ { "name": "client", "description": "", "item": [ { "name": "catalog", "description": "", "item": [ { "name": "status", "description": "", "item": [ { "id": "01824324-bc65-45f8-9722-0b1b85eab1ec", "name": "Key smoke-test", "request": { "name": "Key smoke-test", "description": { "content": "Echoes the authenticated key's identity, name, scopes and expiry.\nRequires a valid key but no particular scope — the fastest way for an\nintegrator to confirm credentials and see the granted scopes.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bb72bec3-ab6b-4250-8e68-150d432d5d25", "name": "The authenticated key context.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"brand_id\": \"\",\n \"key_id\": \"\",\n \"scopes\": [\n \"catalog.stock:ingest\",\n \"catalog.stock:ingest\"\n ],\n \"name\": \"\",\n \"expires_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "289c26f0-f969-45a1-8c2a-80321af282c9", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cb02ff9-04cc-406c-a852-429c04342455", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "products", "description": "", "item": [ { "id": "70e65202-1d76-41f3-a6d1-765b9bdcf24a", "name": "List products", "request": { "name": "List products", "description": { "content": "Superset product list for the key's brand. Requires\n`catalog.products:read`.\n\nThe additive `stock_summary` object is served only when the key ALSO\ncarries `catalog.stock:read` (amendment A4). Soft-deleted products are\nexcluded.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Exact SKU match.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "Filter on the active flag.", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "Keep only variant-parent products (true) or simple products (false).", "type": "text/plain" }, "key": "has_variants", "value": "" }, { "disabled": false, "description": { "content": "Only products with `updated_at` at or after this ISO-8601 instant.", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated sort keys; a leading `-` means descending. Allowed\nfields: `sku`, `created_at`, `updated_at`. Unknown fields are\nignored; the default is `-updated_at`.\n", "type": "text/plain" }, "key": "sort", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3ede1620-10b5-4525-a9df-ca44d965529c", "name": "A page of products.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Exact SKU match.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "Filter on the active flag.", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "Keep only variant-parent products (true) or simple products (false).", "type": "text/plain" }, "key": "has_variants", "value": "" }, { "disabled": false, "description": { "content": "Only products with `updated_at` at or after this ISO-8601 instant.", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated sort keys; a leading `-` means descending. Allowed\nfields: `sku`, `created_at`, `updated_at`. Unknown fields are\nignored; the default is `-updated_at`.\n", "type": "text/plain" }, "key": "sort", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"tu_id\": \"\",\n \"sku\": \"\",\n \"is_active\": \"\",\n \"has_variants\": \"\",\n \"price_range\": \"\",\n \"availability\": {\n \"status\": \"\"\n },\n \"stock_summary\": {\n \"total_quantity\": \"\",\n \"total_reserved\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"tu_id\": \"\",\n \"sku\": \"\",\n \"is_active\": \"\",\n \"has_variants\": \"\",\n \"price_range\": \"\",\n \"availability\": {\n \"status\": \"\"\n },\n \"stock_summary\": {\n \"total_quantity\": \"\",\n \"total_reserved\": \"\"\n },\n \"key_0\": false,\n \"key_1\": 7573.161471671301,\n \"key_2\": 6475\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total\": \"\",\n \"last_page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3c5869c-25aa-4b61-8191-a0ade992bde6", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Exact SKU match.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "Filter on the active flag.", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "Keep only variant-parent products (true) or simple products (false).", "type": "text/plain" }, "key": "has_variants", "value": "" }, { "disabled": false, "description": { "content": "Only products with `updated_at` at or after this ISO-8601 instant.", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated sort keys; a leading `-` means descending. Allowed\nfields: `sku`, `created_at`, `updated_at`. Unknown fields are\nignored; the default is `-updated_at`.\n", "type": "text/plain" }, "key": "sort", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8b55bdf-f535-4792-baea-bdd34aa7cc05", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Exact SKU match.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "Filter on the active flag.", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "Keep only variant-parent products (true) or simple products (false).", "type": "text/plain" }, "key": "has_variants", "value": "" }, { "disabled": false, "description": { "content": "Only products with `updated_at` at or after this ISO-8601 instant.", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated sort keys; a leading `-` means descending. Allowed\nfields: `sku`, `created_at`, `updated_at`. Unknown fields are\nignored; the default is `-updated_at`.\n", "type": "text/plain" }, "key": "sort", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da9bcd02-c906-4cc9-9382-0b9c7874228a", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Exact SKU match.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "Filter on the active flag.", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "Keep only variant-parent products (true) or simple products (false).", "type": "text/plain" }, "key": "has_variants", "value": "" }, { "disabled": false, "description": { "content": "Only products with `updated_at` at or after this ISO-8601 instant.", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated sort keys; a leading `-` means descending. Allowed\nfields: `sku`, `created_at`, `updated_at`. Unknown fields are\nignored; the default is `-updated_at`.\n", "type": "text/plain" }, "key": "sort", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5878aba0-fe9d-4fdb-9e9e-34c8e4b02979", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Exact SKU match.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "Filter on the active flag.", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "Keep only variant-parent products (true) or simple products (false).", "type": "text/plain" }, "key": "has_variants", "value": "" }, { "disabled": false, "description": { "content": "Only products with `updated_at` at or after this ISO-8601 instant.", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated sort keys; a leading `-` means descending. Allowed\nfields: `sku`, `created_at`, `updated_at`. Unknown fields are\nignored; the default is `-updated_at`.\n", "type": "text/plain" }, "key": "sort", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d5c233d0-3981-4712-b942-31c574ab8043", "name": "Create a product", "request": { "name": "Create a product", "description": { "content": "Creates a product with its Profile, default-language settings and\noptional `versions` translations. Requires `catalog.products:write`.\n\n**Idempotency-Key is REQUIRED** (amendment A3): `products.sku` has no\ndatabase UNIQUE constraint, so a replay after a network timeout could\notherwise forge a real duplicate.\n\n- `sku` is required; brand uniqueness (against products AND variants,\n including soft-deleted variants) is enforced as a `409 duplicate_sku`.\n- `is_active` defaults to `false`.\n- `type` defaults to `simple`.\n- Stock, media, categories and markets are NOT settable here (any\n `stock_count` / `stock_type` key is silently dropped — guard G1).\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"EUR\",\n \"tax_class\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"default_language\": \"\",\n \"versions\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6649ce4b-8c7f-4da0-9eef-f46fb91d954c", "name": "The created product (superset detail shape).", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"EUR\",\n \"tax_class\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"default_language\": \"\",\n \"versions\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Replayed", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"id\": \"\",\n \"tu_id\": \"\",\n \"sku\": \"\",\n \"is_active\": \"\",\n \"has_variants\": \"\",\n \"price_range\": \"\",\n \"availability\": {\n \"status\": \"\"\n },\n \"stock_summary\": {\n \"total_quantity\": \"\",\n \"total_reserved\": \"\"\n },\n \"axes\": [\n {\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"values\": [\n {\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"values\": [\n {\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\"\n }\n ]\n }\n ],\n \"variants\": [\n {\n \"tu_id\": \"\",\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"inherited\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\",\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\"\n },\n \"barcode\": \"\"\n },\n {\n \"tu_id\": \"\",\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"inherited\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\",\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\"\n },\n \"barcode\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6100b3cc-590c-436c-b65f-865bca559f21", "name": "This endpoint requires an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"EUR\",\n \"tax_class\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"default_language\": \"\",\n \"versions\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "486d7fc7-fe53-44a9-a8fe-6c7ee7fcba02", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"EUR\",\n \"tax_class\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"default_language\": \"\",\n \"versions\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baff57f0-aced-4e88-aacf-32ac6ee8af84", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"EUR\",\n \"tax_class\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"default_language\": \"\",\n \"versions\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74eaef57-17af-42ad-92f6-1c07825818eb", "name": "The SKU is already taken by a product or variant of the brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"EUR\",\n \"tax_class\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"default_language\": \"\",\n \"versions\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fb1ee66-68cd-4808-adde-c94033019960", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"EUR\",\n \"tax_class\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"default_language\": \"\",\n \"versions\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f280aef7-2bfc-4fe1-8e96-482810f48c2e", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"EUR\",\n \"tax_class\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"default_language\": \"\",\n \"versions\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{tuId}", "description": "", "item": [ { "id": "1deab64f-314e-4b8a-b163-b2f2dce08f2c", "name": "Get a product", "request": { "name": "Get a product", "description": { "content": "Superset product detail: core fields plus `axes`, `variants`,\n`price_range`, `availability` and (with `catalog.stock:read`)\n`stock_summary`. Requires `catalog.products:read`.\n\nAmendment A4: without `catalog.stock:read`, `stock_summary` is omitted\nand each `variants[].availability.quantity` is stripped (the\n`availability.status` merchandising signal remains).\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "tuId", "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2957a5a8-6239-4567-9d44-0bc31865d0c3", "name": "The product.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"id\": \"\",\n \"tu_id\": \"\",\n \"sku\": \"\",\n \"is_active\": \"\",\n \"has_variants\": \"\",\n \"price_range\": \"\",\n \"availability\": {\n \"status\": \"\"\n },\n \"stock_summary\": {\n \"total_quantity\": \"\",\n \"total_reserved\": \"\"\n },\n \"axes\": [\n {\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"values\": [\n {\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"values\": [\n {\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\"\n }\n ]\n }\n ],\n \"variants\": [\n {\n \"tu_id\": \"\",\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"inherited\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\",\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\"\n },\n \"barcode\": \"\"\n },\n {\n \"tu_id\": \"\",\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"inherited\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\",\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\"\n },\n \"barcode\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1eb6c7db-5c59-4605-9ccc-2d07f0f9054d", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14e5e33d-e3ec-4de1-a9d2-1746c8045a74", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9f4edbb-7c99-4794-a712-b4c15a840a6c", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1af9348f-637e-4e4b-9ffa-75dd6984c66b", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d80ad60-e6df-4d9a-9785-d8a27c4f4695", "name": "Update a product (partial)", "request": { "name": "Update a product (partial)", "description": { "content": "Partial update — only the fields present in the body are written.\nRequires `catalog.products:write`. Idempotency-Key is OPTIONAL here\n(a PATCH is naturally re-runnable). Archive a product by sending\n`is_active: false`. `title` cannot be nulled.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "tuId", "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"USD\",\n \"tax_class\": \"\",\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"versions\": {\n \"key_0\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_1\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_2\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "48d790f2-87f1-4950-a27c-1349d46b55d7", "name": "The updated product (superset detail shape).", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"USD\",\n \"tax_class\": \"\",\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"versions\": {\n \"key_0\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_1\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_2\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Replayed", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"id\": \"\",\n \"tu_id\": \"\",\n \"sku\": \"\",\n \"is_active\": \"\",\n \"has_variants\": \"\",\n \"price_range\": \"\",\n \"availability\": {\n \"status\": \"\"\n },\n \"stock_summary\": {\n \"total_quantity\": \"\",\n \"total_reserved\": \"\"\n },\n \"axes\": [\n {\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"values\": [\n {\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"values\": [\n {\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\"\n }\n ]\n }\n ],\n \"variants\": [\n {\n \"tu_id\": \"\",\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"inherited\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\",\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\"\n },\n \"barcode\": \"\"\n },\n {\n \"tu_id\": \"\",\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"inherited\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\",\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\"\n },\n \"barcode\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f66b9da0-caee-4572-8cac-e153eea23a30", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"USD\",\n \"tax_class\": \"\",\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"versions\": {\n \"key_0\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_1\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_2\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01935df4-9da1-4914-ae31-e23e04ca39d8", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"USD\",\n \"tax_class\": \"\",\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"versions\": {\n \"key_0\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_1\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_2\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "851a9e2b-e3a2-49b9-bcc1-259a3d62920b", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"USD\",\n \"tax_class\": \"\",\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"versions\": {\n \"key_0\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_1\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_2\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e714c2b1-73ff-4e03-9f82-7ab1208c27f2", "name": "The SKU is already taken by a product or variant of the brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"USD\",\n \"tax_class\": \"\",\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"versions\": {\n \"key_0\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_1\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_2\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe7befdc-7ca7-41b0-a704-359cd143203d", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"USD\",\n \"tax_class\": \"\",\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"versions\": {\n \"key_0\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_1\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_2\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc61b06c-dac5-43a8-baac-3f239888873f", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"type\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"USD\",\n \"tax_class\": \"\",\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\",\n \"is_active\": \"\",\n \"versions\": {\n \"key_0\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_1\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n },\n \"key_2\": {\n \"title\": \"\",\n \"short_description\": \"\",\n \"long_description\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "axes", "description": "", "item": [ { "id": "66c19c4b-9b5b-4725-9cee-c4cd34d95b03", "name": "Get a product's axis selection", "request": { "name": "Get a product's axis selection", "description": { "content": "The axes effectively selected on the product (attached axes and their\nselected value subset). Requires `catalog.products:read`. Not paginated.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "tuId", "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ef16de23-1445-443d-bb68-9354b7552f72", "name": "The product's effective axis selection.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": [\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": [\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "677ae282-fc2e-4e78-998b-d6acd75e1aa2", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cae9e835-9e0a-4862-91e9-89b128d3cdc9", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "989b2d39-3e4f-4df7-abf4-dfdff2895b64", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6735197d-a672-4369-89df-2d5e1cb7b5b1", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d71aa627-85ea-49b7-a1f3-76370329c051", "name": "Replace a product's axis selection (declarative)", "request": { "name": "Replace a product's axis selection (declarative)", "description": { "content": "Declaratively sets the product's axis selection by codes/values. The\narray order is the per-product axis position. An empty `axes` array\ndetaches everything. Requires `catalog.variants:write` (selecting axes\nis a variant-management gesture). Idempotent by nature — no\nIdempotency-Key.\n\nError semantics (identical to the internal admin path):\n- unknown code/value → `422`, indexed at `axes.{i}.code` /\n `axes.{i}.values.{j}`;\n- attaching a NEW inactive axis or selecting a NEW inactive value → `422`;\n- attaching a new axis, or removing a value a live variant uses, while\n the product already has variants → `422`;\n- detaching an axis a live variant still carries → `409 axis_in_use`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "tuId", "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"axes\": [\n {\n \"code\": \"LXN8dgN_k\",\n \"values\": [\n \"Pb8\"\n ]\n },\n {\n \"code\": \"wg9gR\",\n \"values\": [\n \"cxWVqga7wu\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fdbba8ca-16f8-4495-907d-3ce67c68e6bd", "name": "The resulting effective axis selection.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"axes\": [\n {\n \"code\": \"LXN8dgN_k\",\n \"values\": [\n \"Pb8\"\n ]\n },\n {\n \"code\": \"wg9gR\",\n \"values\": [\n \"cxWVqga7wu\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": [\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": [\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bd19fef-82bd-4774-a9a0-f7808612557c", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"axes\": [\n {\n \"code\": \"LXN8dgN_k\",\n \"values\": [\n \"Pb8\"\n ]\n },\n {\n \"code\": \"wg9gR\",\n \"values\": [\n \"cxWVqga7wu\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b7dabd0-4999-4068-ad74-b3d10bcac2fe", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"axes\": [\n {\n \"code\": \"LXN8dgN_k\",\n \"values\": [\n \"Pb8\"\n ]\n },\n {\n \"code\": \"wg9gR\",\n \"values\": [\n \"cxWVqga7wu\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc13645f-e3a9-4a19-8d4d-96859737b810", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"axes\": [\n {\n \"code\": \"LXN8dgN_k\",\n \"values\": [\n \"Pb8\"\n ]\n },\n {\n \"code\": \"wg9gR\",\n \"values\": [\n \"cxWVqga7wu\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cedaa6a-816a-44d1-b7da-1658e1660a2d", "name": "Cannot detach an axis that a variant of this product still uses.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"axes\": [\n {\n \"code\": \"LXN8dgN_k\",\n \"values\": [\n \"Pb8\"\n ]\n },\n {\n \"code\": \"wg9gR\",\n \"values\": [\n \"cxWVqga7wu\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c893b0d-1f1e-488a-b52e-007c401614ef", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"axes\": [\n {\n \"code\": \"LXN8dgN_k\",\n \"values\": [\n \"Pb8\"\n ]\n },\n {\n \"code\": \"wg9gR\",\n \"values\": [\n \"cxWVqga7wu\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b14c397a-0910-4842-99a0-98802d07f74e", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"axes\": [\n {\n \"code\": \"LXN8dgN_k\",\n \"values\": [\n \"Pb8\"\n ]\n },\n {\n \"code\": \"wg9gR\",\n \"values\": [\n \"cxWVqga7wu\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "variants", "description": "", "item": [ { "id": "dcd7519e-90b1-4a66-bc37-e7f6123e2d27", "name": "List a product's variants", "request": { "name": "List a product's variants", "description": { "content": "The product's variants (soft-deleted excluded). Requires\n`catalog.products:read`. Amendment A4: without `catalog.stock:read` each\n`availability.quantity` is stripped (the `availability.status` remains).\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "Exact SKU match.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [ { "type": "any", "value": "", "key": "tuId", "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "78738735-0651-4fc8-adca-25182be37c94", "name": "A page of variants.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "Exact SKU match.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"tu_id\": \"\",\n \"product_id\": \"\",\n \"sku\": \"\",\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"inherited\": \"\"\n },\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\"\n },\n \"is_active\": \"\",\n \"barcode\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"\",\n \"position\": \"\",\n \"axis_values_detail\": [\n {\n \"axis_code\": \"\",\n \"axis_label\": \"\",\n \"value\": \"\",\n \"label\": \"\"\n },\n {\n \"axis_code\": \"\",\n \"axis_label\": \"\",\n \"value\": \"\",\n \"label\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"tu_id\": \"\",\n \"product_id\": \"\",\n \"sku\": \"\",\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"inherited\": \"\"\n },\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\"\n },\n \"is_active\": \"\",\n \"barcode\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"\",\n \"position\": \"\",\n \"axis_values_detail\": [\n {\n \"axis_code\": \"\",\n \"axis_label\": \"\",\n \"value\": \"\",\n \"label\": \"\"\n },\n {\n \"axis_code\": \"\",\n \"axis_label\": \"\",\n \"value\": \"\",\n \"label\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total\": \"\",\n \"last_page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7bf0897-4672-4b22-87db-66064cc456db", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "Exact SKU match.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1df170c-8497-445e-8e90-ba90a7e0ef20", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "Exact SKU match.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ffdfc22-39c6-4342-976b-d57f4bc56902", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "Exact SKU match.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fb2d680-c887-4b9e-a40e-2c870453346a", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "Exact SKU match.", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e0c8b69-9371-4556-b152-a56462cf442d", "name": "Create a variant", "request": { "name": "Create a variant", "description": { "content": "Creates one variant of the product. Requires `catalog.variants:write`.\n**Idempotency-Key is REQUIRED** (amendment A3).\n\n`axis_values` maps each axis code of the product's effective selection\nto exactly one selected value. A malformed axis payload is a `422`; a\nSKU collision (against products AND variants of the brand) or an\nalready-existing axis combination is a `409`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "tuId", "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"barcode\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a6354e30-98ae-4a20-8bee-ad39a3972df4", "name": "The created variant.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"barcode\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"tu_id\": \"\",\n \"product_id\": \"\",\n \"sku\": \"\",\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"inherited\": \"\"\n },\n \"axis_values\": {\n \"key_0\": \"\"\n },\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\"\n },\n \"is_active\": \"\",\n \"barcode\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"\",\n \"position\": \"\",\n \"axis_values_detail\": [\n {\n \"axis_code\": \"\",\n \"axis_label\": \"\",\n \"value\": \"\",\n \"label\": \"\"\n },\n {\n \"axis_code\": \"\",\n \"axis_label\": \"\",\n \"value\": \"\",\n \"label\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fd219dc-9563-4ac5-8039-146e89ac14e8", "name": "This endpoint requires an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"barcode\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52ce25a8-6e4b-4304-abad-b29090fee779", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"barcode\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "481a21f6-14b2-46ab-a3a4-2de0ff7db720", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"barcode\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bfc15f7-6200-40e5-af78-939a4a9bd272", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"barcode\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10a2d8ea-9651-4232-a157-e0a2c543c830", "name": "A duplicate SKU (`duplicate_sku`) or an already-existing axis\ncombination (`conflict`).", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"barcode\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad4d69c0-0f4c-4c4e-b4f2-4b4f786d602e", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"barcode\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e58fd151-a7db-4222-a37b-eb42732f886e", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"axis_values\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"barcode\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "generate", "description": "", "item": [ { "id": "49959564-1dcb-4fc5-80e1-bc36aefa6918", "name": "Generate variants (cartesian)", "request": { "name": "Generate variants (cartesian)", "description": { "content": "Expands the product's effective axis selection into its cartesian\nproduct, skips combinations that already exist, and creates the rest.\nRequires `catalog.variants:write`. **Idempotency-Key is REQUIRED**\n(amendment A3).\n\n- The expansion is capped at 500 combinations → `422 variant_cap_exceeded`.\n- A product with no axis selection is a `422 no_axes_selected`.\n- `dry_run: true` returns the plan with no writes (`200`).\n- A concurrent SKU collision during generation is a replayable\n `409 conflict`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "tuId", "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dry_run\": \"\",\n \"activate\": \"\",\n \"sku_template\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0c2a4e4b-1630-482c-ac61-e40777d7c918", "name": "The dry-run plan (only returned when `dry_run: true`).", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dry_run\": \"\",\n \"activate\": \"\",\n \"sku_template\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total_combinations\": \"\",\n \"would_create\": \"\",\n \"skipped_existing\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49f838c2-9966-4990-9975-f2a072ac3d87", "name": "The generated variants.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dry_run\": \"\",\n \"activate\": \"\",\n \"sku_template\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Replayed", "value": "" } ], "body": "{\n \"total_combinations\": \"\",\n \"created\": \"\",\n \"skipped_existing\": \"\",\n \"variants\": [\n {\n \"id\": \"\",\n \"tu_id\": \"\",\n \"product_id\": \"\",\n \"sku\": \"\",\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"inherited\": \"\"\n },\n \"axis_values\": {\n \"key_0\": \"\"\n },\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\"\n },\n \"is_active\": \"\",\n \"barcode\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"\",\n \"position\": \"\",\n \"axis_values_detail\": [\n {\n \"axis_code\": \"\",\n \"axis_label\": \"\",\n \"value\": \"\",\n \"label\": \"\"\n },\n {\n \"axis_code\": \"\",\n \"axis_label\": \"\",\n \"value\": \"\",\n \"label\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"tu_id\": \"\",\n \"product_id\": \"\",\n \"sku\": \"\",\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"inherited\": \"\"\n },\n \"axis_values\": {\n \"key_0\": \"\"\n },\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\"\n },\n \"is_active\": \"\",\n \"barcode\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"\",\n \"position\": \"\",\n \"axis_values_detail\": [\n {\n \"axis_code\": \"\",\n \"axis_label\": \"\",\n \"value\": \"\",\n \"label\": \"\"\n },\n {\n \"axis_code\": \"\",\n \"axis_label\": \"\",\n \"value\": \"\",\n \"label\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d45c851e-8e73-43f3-b9d0-02bf2ca4ad25", "name": "This endpoint requires an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dry_run\": \"\",\n \"activate\": \"\",\n \"sku_template\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8945a811-6a08-47c2-a8cb-39695579a616", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dry_run\": \"\",\n \"activate\": \"\",\n \"sku_template\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b921b984-045a-479c-9e01-38af9ff4d58b", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dry_run\": \"\",\n \"activate\": \"\",\n \"sku_template\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ca99b7a-279e-4e6a-be66-29777aed4868", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dry_run\": \"\",\n \"activate\": \"\",\n \"sku_template\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4eef6e6-377f-4c5e-b5fb-2c339f1584e1", "name": "A SKU conflict occurred while generating; retry the request.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dry_run\": \"\",\n \"activate\": \"\",\n \"sku_template\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54248837-8f70-45c0-a317-e6f639775b44", "name": "No axes selected (`no_axes_selected`) or too many combinations\n(`variant_cap_exceeded`).", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dry_run\": \"\",\n \"activate\": \"\",\n \"sku_template\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d8bcd5b-901f-43fd-abe7-2f61a6b0dbbd", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "variants", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"dry_run\": \"\",\n \"activate\": \"\",\n \"sku_template\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "stock", "description": "", "item": [ { "id": "e89aa032-c3b5-4de1-a132-dffce4032ca7", "name": "Get a product's stock", "request": { "name": "Get a product's stock", "description": { "content": "Stock levels for a product, keyed by variant × location, plus the\nproduct-level rows and the aggregate availability. Requires\n`catalog.stock:read`. Filters: `location` (external_code) and `variant`\n(variant tu_id).\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "Variant tu_id.", "type": "text/plain" }, "key": "variant", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "tuId", "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d71762e1-846d-4908-8b0e-8791e168b137", "name": "The product stock view.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "Variant tu_id.", "type": "text/plain" }, "key": "variant", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"product_tu_id\": \"\",\n \"variants\": [\n {\n \"tu_id\": \"\",\n \"sku\": \"\",\n \"is_active\": \"\",\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\",\n \"synced_at\": \"\"\n },\n \"levels\": [\n {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"location\": \"\",\n \"source_updated_at\": \"\"\n },\n {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"location\": \"\",\n \"source_updated_at\": \"\"\n }\n ]\n },\n {\n \"tu_id\": \"\",\n \"sku\": \"\",\n \"is_active\": \"\",\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\",\n \"synced_at\": \"\"\n },\n \"levels\": [\n {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"location\": \"\",\n \"source_updated_at\": \"\"\n },\n {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"location\": \"\",\n \"source_updated_at\": \"\"\n }\n ]\n }\n ],\n \"product_levels\": [\n {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"location\": \"\",\n \"source_updated_at\": \"\"\n },\n {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"location\": \"\",\n \"source_updated_at\": \"\"\n }\n ],\n \"availability\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53106927-9490-441d-bf33-dc9d0f1c2029", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "Variant tu_id.", "type": "text/plain" }, "key": "variant", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97d1183e-6ad1-4381-bd8f-668ec7e12f49", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "Variant tu_id.", "type": "text/plain" }, "key": "variant", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f0c6419-f8e6-4e60-8b85-e689776fb5eb", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "Variant tu_id.", "type": "text/plain" }, "key": "variant", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f4be78c-876e-448b-ab9c-9bc583e71392", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "Variant tu_id.", "type": "text/plain" }, "key": "variant", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "movements", "description": "", "item": [ { "id": "77fa8968-bbec-4b98-a856-3f36385df397", "name": "Get a product's stock movement ledger", "request": { "name": "Get a product's stock movement ledger", "description": { "content": "The product's stock movement ledger, newest first. Requires\n`catalog.stock:read`. Filters: `location` (external_code) and `variant`\n(variant tu_id). Movements written through the Client API adjust carry\nno actor.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "movements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "Variant tu_id.", "type": "text/plain" }, "key": "variant", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [ { "type": "any", "value": "", "key": "tuId", "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0b2cbabb-e423-4175-8fb0-a194d991cae9", "name": "A page of movements.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "movements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "Variant tu_id.", "type": "text/plain" }, "key": "variant", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"delta\": \"\",\n \"reason\": \"\",\n \"occurred_at\": \"\",\n \"note\": \"\",\n \"location\": \"\",\n \"variant\": \"\"\n },\n {\n \"delta\": \"\",\n \"reason\": \"\",\n \"occurred_at\": \"\",\n \"note\": \"\",\n \"location\": \"\",\n \"variant\": \"\"\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total\": \"\",\n \"last_page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2784a0db-48e5-46ef-b074-dd199abcebdf", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "movements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "Variant tu_id.", "type": "text/plain" }, "key": "variant", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7ffff52-9419-4c2a-bb0d-620c9d9f55c1", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "movements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "Variant tu_id.", "type": "text/plain" }, "key": "variant", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07836c01-bbe2-4fba-a410-013a678318a9", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "movements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "Variant tu_id.", "type": "text/plain" }, "key": "variant", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7de8053c-e2cf-40d4-8f4c-e5d435316a19", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "movements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "Variant tu_id.", "type": "text/plain" }, "key": "variant", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "adjust", "description": "", "item": [ { "id": "6cdab5b5-4955-441e-be92-c72764e90d86", "name": "Set an absolute stock quantity", "request": { "name": "Set an absolute stock quantity", "description": { "content": "Sets an absolute quantity for a (product|variant) × location. Requires\n`catalog.stock:write`. **Idempotency-Key is REQUIRED** (amendment A3).\n\n- `variant` is required for a variant-parent product and forbidden for a\n simple one.\n- A null `location` resolves to the per-brand `__default__` sentinel\n (auto-created); a supplied `location` must already exist.\n- `reserved` is preserved and NOT writable (sending it is a `422`).\n- Optimistic locking: pass `expected_quantity` to get a\n `409 stock_version_conflict` (carrying `current_quantity`) if the\n level changed since you read it.\n- The movement records reason `manual` and no actor; the note defaults\n to `client-api:`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "tuId", "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\",\n \"variant\": \"\",\n \"location\": \"\",\n \"expected_quantity\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "731f8725-9615-400d-9a9b-72f4c3546941", "name": "The resulting level and (when the quantity changed) the movement.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\",\n \"variant\": \"\",\n \"location\": \"\",\n \"expected_quantity\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Replayed", "value": "" } ], "body": "{\n \"level\": {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"source_updated_at\": \"\",\n \"location\": \"\",\n \"variant\": \"\"\n },\n \"movement\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7aeb9aa-adb9-487a-abb3-51f63a134e3d", "name": "This endpoint requires an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\",\n \"variant\": \"\",\n \"location\": \"\",\n \"expected_quantity\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ee3cdfc-8451-46db-8d2d-eedb35536285", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\",\n \"variant\": \"\",\n \"location\": \"\",\n \"expected_quantity\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8e68e6c-b4c4-460d-b915-6dfb129cb520", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\",\n \"variant\": \"\",\n \"location\": \"\",\n \"expected_quantity\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58307ac3-7b27-40ac-945d-890c62acc578", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\",\n \"variant\": \"\",\n \"location\": \"\",\n \"expected_quantity\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fda3c5a-91d0-4d5b-bca7-cedb6cdfee10", "name": "The level changed since you read it (`stock_version_conflict`,\ncarrying `current_quantity`), or the write was rejected on a\nconflicting timestamp (`rejected_stale`).", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\",\n \"variant\": \"\",\n \"location\": \"\",\n \"expected_quantity\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce6e162d-a5c0-4acd-9710-a673a7d499f2", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\",\n \"variant\": \"\",\n \"location\": \"\",\n \"expected_quantity\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11234361-9c74-48b1-bedb-948e895b50e4", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "products", ":tuId", "stock", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Product opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Client-generated idempotency token (max 191 chars). REQUIRED on this\nendpoint. A replay with the same key and identical body returns the\noriginal response with `Idempotency-Replayed: true`; a different body\nwith the same key is a `409 idempotency_key_reuse`. Settled responses\nare retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"quantity\": \"\",\n \"variant\": \"\",\n \"location\": \"\",\n \"expected_quantity\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "axes", "description": "", "item": [ { "id": "b624e085-85df-4f13-8543-43082f93dddd", "name": "List brand axes", "request": { "name": "List brand axes", "description": { "content": "The brand's variant-axis library with nested values. Requires `catalog.products:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "axes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "25a58838-556c-4a00-b9fd-5438ceef1688", "name": "A page of axes.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": [\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": [\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n }\n ]\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total\": \"\",\n \"last_page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b1e426b-0a42-4e4d-a3bd-2c103227607a", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8798cb7-c6cb-4375-929e-e365dd4abac3", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f95bb3e-039a-4a27-81b4-4b1498fcfcbb", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a679591-83d2-452d-ac67-13b8344fe7dc", "name": "Create an axis", "request": { "name": "Create an axis", "description": { "content": "Creates a brand axis, optionally with an initial set of values.\nRequires `catalog.axes:write`. `code` is unique per brand — a collision\nis a `409 duplicate_axis_code`. Idempotency-Key is optional.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"3rypia\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a3b18d82-7625-45da-8bc3-1b87ef20594b", "name": "The created axis.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"3rypia\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": [\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6626e79f-7a51-4716-9cb7-715c19266eb5", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"3rypia\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb015f4c-aa53-46b4-84ab-2a9b4be3afda", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"3rypia\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72b5bc71-b649-43b8-ba62-09a9bd5a6c47", "name": "An axis with this code already exists for the brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"3rypia\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c183cb1-1369-4e34-842a-fae68f70549a", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"3rypia\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bd9f1e4-7b0c-4df4-b246-80731de05cd5", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"3rypia\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{code}", "description": "", "item": [ { "id": "44feba83-38d8-436d-bb07-41a312b0953c", "name": "Update an axis (partial)", "request": { "name": "Update an axis (partial)", "description": { "content": "Updates `label`, `position` or `is_active`. Requires\n`catalog.axes:write`. `code` is immutable — sending it is a `422`\n(`prohibited`).\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "888315a0-a991-4cf7-a1e7-c26162dfd2d3", "name": "The updated axis.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"code\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\",\n \"values\": [\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f415101-68bb-4b7b-8f83-3bae0888cd2a", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48a8f10e-555a-4439-80de-e1bd525a45e1", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22c21d0e-a43d-4d48-b6df-8afea0bab5e2", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e4deb6f-8461-47c0-ac97-9c9fef7e3190", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15c21ef5-a0a7-44b2-b11d-d4689123b800", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "552ca33b-124e-45c2-a55d-ee07288d7d75", "name": "Delete an axis", "request": { "name": "Delete an axis", "description": { "content": "Deletes an unused axis. Requires `catalog.axes:write`. Refused with\n`409 axis_in_use` when the axis is attached to a product or one of its\nvalues is referenced by a variant.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "1abfedd1-c477-4f72-8dda-4ce87e65d4ab", "name": "Deleted.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee36a481-29fa-416d-9fc5-fc29720d643c", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dc1846c-5607-4a2b-a639-a9f5abf583ed", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb7154c9-4717-43ee-a987-5bb6c6f9c9ad", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4521245-b22d-4913-95d1-d8e47b224b5c", "name": "The axis is attached to a product or used by a variant.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec017658-dee8-4c25-9411-8501a5d328b6", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "values", "description": "", "item": [ { "id": "8fb0e2a2-206a-4138-80b6-e9ec50a0acc7", "name": "Add a value to an axis", "request": { "name": "Add a value to an axis", "description": { "content": "Adds a value to the axis. Requires `catalog.axes:write`. `(axis, value)`\nis unique — a collision is a `409 duplicate_axis_value`. Idempotency-Key\nis optional.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"ZOvOc8E6\",\n \"label\": \"\",\n \"position\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "29e5e73c-f787-4342-a338-5a54ce5d845e", "name": "The created value.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"ZOvOc8E6\",\n \"label\": \"\",\n \"position\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a98bb964-d2d7-415f-b9cb-68996944f090", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"ZOvOc8E6\",\n \"label\": \"\",\n \"position\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0db57bc-90ab-4d58-bc2c-b0104745ecaa", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"ZOvOc8E6\",\n \"label\": \"\",\n \"position\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e86fb147-5c9e-4dd7-88d4-aa1755832f0b", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"ZOvOc8E6\",\n \"label\": \"\",\n \"position\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62e550ac-738f-4220-9898-1fcdc0e59795", "name": "A value with this code already exists on the axis.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"ZOvOc8E6\",\n \"label\": \"\",\n \"position\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2096b054-9113-4aba-832a-6070fa535cda", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"ZOvOc8E6\",\n \"label\": \"\",\n \"position\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f06eaa9-0ef3-4a9c-b592-d5b87edf5fe4", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"value\": \"ZOvOc8E6\",\n \"label\": \"\",\n \"position\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{value}", "description": "", "item": [ { "id": "5a1ce125-f872-47fc-86d2-1e731f4c3fec", "name": "Update an axis value (partial)", "request": { "name": "Update an axis value (partial)", "description": { "content": "Updates `label`, `position` or `is_active`. Requires\n`catalog.axes:write`. `value` is immutable — sending it is a `422`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" } }, { "type": "any", "value": "", "key": "value", "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8e3d99cc-6059-4b4c-9925-642e196f3487", "name": "The updated value.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "value" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"value\": \"\",\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57a16a29-d960-4387-8b55-ee77226538a2", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "value" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "971bfa38-fb77-4efa-b3e2-f0fe69b47efe", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "value" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f9af575-b819-4d27-a4e5-c450cb86e972", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "value" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acef5c6b-9b46-4e4d-a26d-129a212eddfb", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "value" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86706feb-e4f7-4aba-9178-7fa3f70d1c4a", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "value" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b61220d2-3702-4ea2-8e19-38fe8682da09", "name": "Delete an axis value", "request": { "name": "Delete an axis value", "description": { "content": "Deletes an unused value. Requires `catalog.axes:write`. Refused with\n`409 value_in_use` when the value is referenced by a variant or selected\nby a product.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" } }, { "type": "any", "value": "", "key": "value", "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "88d97e48-2c35-4e48-9a60-61ac786e1ba4", "name": "Deleted.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "value" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c70eb893-a285-4ea4-a385-2443e7218aa5", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "value" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "856cf728-7cc7-427c-9246-7231522e91ba", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "value" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d39fbac-acfe-4e8d-b583-878960b4963a", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "value" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7229faa2-0233-4276-8de2-30324d882da0", "name": "The value is used by a variant or selected by a product.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "value" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96c9719e-33c0-4b78-8ff7-6c49e189879c", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "axes", ":code", "values", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand axis code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Axis value (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "value" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "variants", "description": "", "item": [ { "name": "{tuId}", "description": "", "item": [ { "id": "641c45a3-4cdb-44df-abfd-496f91e79b2c", "name": "Update a variant (partial)", "request": { "name": "Update a variant (partial)", "description": { "content": "Partial update. Requires `catalog.variants:write`. `axis_values` is\nimmutable (`422`) — recreate the variant to change its combination.\n`price.value: null` clears the override so the variant inherits the\nparent product's price. A SKU collision is a `409 duplicate_sku`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "tuId", "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"barcode\": \"\",\n \"price\": {\n \"value\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d0ba6ce8-6e6d-4bf6-a47c-e1a4b96cd342", "name": "The updated variant.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"barcode\": \"\",\n \"price\": {\n \"value\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"tu_id\": \"\",\n \"product_id\": \"\",\n \"sku\": \"\",\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"inherited\": \"\"\n },\n \"axis_values\": {\n \"key_0\": \"\"\n },\n \"availability\": {\n \"status\": \"\",\n \"quantity\": \"\"\n },\n \"is_active\": \"\",\n \"barcode\": \"\",\n \"price_value\": \"\",\n \"price_currency\": \"\",\n \"position\": \"\",\n \"axis_values_detail\": [\n {\n \"axis_code\": \"\",\n \"axis_label\": \"\",\n \"value\": \"\",\n \"label\": \"\"\n },\n {\n \"axis_code\": \"\",\n \"axis_label\": \"\",\n \"value\": \"\",\n \"label\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98233251-8a51-40aa-8e37-2d3933e8a9bf", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"barcode\": \"\",\n \"price\": {\n \"value\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04dd5649-03f7-430f-8bf4-cd56d86bbf03", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"barcode\": \"\",\n \"price\": {\n \"value\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e0f427e-49a1-4fce-9bbe-b2105f87c96a", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"barcode\": \"\",\n \"price\": {\n \"value\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09400d45-550f-4295-8ee5-f9ebf6d8185a", "name": "The SKU is already taken by a product or variant of the brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"barcode\": \"\",\n \"price\": {\n \"value\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80067af5-0585-4469-994e-c4c52bd8a19e", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"barcode\": \"\",\n \"price\": {\n \"value\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73933430-e332-4aa8-8afe-2bba2a67708a", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"sku\": \"\",\n \"barcode\": \"\",\n \"price\": {\n \"value\": \"\"\n },\n \"position\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d67c08a-a150-4da4-800e-a36b01fc7781", "name": "Delete a variant", "request": { "name": "Delete a variant", "description": { "content": "Soft-deletes the variant. Requires `catalog.variants:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "tuId", "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "0caeba96-6779-432f-ad49-25c7a3a54fb0", "name": "Deleted.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "612a77ef-4322-4ba8-ba03-96d4d5cd9466", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c456553-9ba8-4317-ad8a-55853c0cc48c", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7eed9bb0-b031-4f56-adaa-64c439f590db", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e93db8a1-9d05-40c3-8709-8400bfd975ca", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "variants", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Variant opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "stock", "description": "", "item": [ { "name": "locations", "description": "", "item": [ { "id": "ef2e986c-4aa7-44b9-b0a4-5ed717b794c2", "name": "List stock locations", "request": { "name": "List stock locations", "description": { "content": "The brand's stock locations. Requires `catalog.stock:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "stock", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a56a1657-82dd-446d-b4a6-23bbc50c7297", "name": "A page of locations.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"external_code\": \"\",\n \"name\": \"\",\n \"is_active\": \"\",\n \"is_default\": \"\",\n \"pointofsale_tu_id\": \"\"\n },\n {\n \"external_code\": \"\",\n \"name\": \"\",\n \"is_active\": \"\",\n \"is_default\": \"\",\n \"pointofsale_tu_id\": \"\"\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total\": \"\",\n \"last_page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecb553a8-4d26-4c8a-ad5a-42776fa68541", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d7b7329-5e4a-43d6-a80a-f4d79d8585a6", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "414fab64-c967-4011-81cf-8b8d79c19f89", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "is_active", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d80d0f90-163a-4faf-b94f-0e4d3854953e", "name": "Create a stock location", "request": { "name": "Create a stock location", "description": { "content": "Mints a brand stock location. Requires `catalog.stock:write`.\n`external_code` is required, URL-safe and unique per brand (collision →\n`409 conflict`). The reserved `__default__` sentinel cannot be minted\n(`422`). Idempotency-Key is optional.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "stock", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_code\": \"9s7nZpkKedZ\",\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "039160aa-44e0-45d0-a429-f945ba27a0ff", "name": "The created location.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_code\": \"9s7nZpkKedZ\",\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"external_code\": \"\",\n \"name\": \"\",\n \"is_active\": \"\",\n \"is_default\": \"\",\n \"pointofsale_tu_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c04c847a-6137-4ae4-9421-108f97e313e9", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_code\": \"9s7nZpkKedZ\",\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7215b84e-3562-4746-bd92-fe117ab08ede", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_code\": \"9s7nZpkKedZ\",\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "798ecfc2-13ac-4419-b41a-d17aa506f052", "name": "A location with this external code already exists for the brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_code\": \"9s7nZpkKedZ\",\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "008e6732-cd9d-4fdd-87cf-3b5591851ed0", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_code\": \"9s7nZpkKedZ\",\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fd7de77-f448-4158-b7f9-4bdb30967d7f", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional client-generated idempotency token (max 191 chars). A replay\nwith the same key and identical body returns the original response with\n`Idempotency-Replayed: true`; a different body with the same key is a\n`409 idempotency_key_reuse`. Settled responses are retained for 24 h.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_code\": \"9s7nZpkKedZ\",\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{externalCode}", "description": "", "item": [ { "id": "cb0bd8ec-a5b6-4312-ad33-77f6603ea61b", "name": "Update a stock location (partial)", "request": { "name": "Update a stock location (partial)", "description": { "content": "Updates `name` or `is_active`. Requires `catalog.stock:write`.\n`external_code` is immutable and POS attachment is not writable — either\nin the body is a `422`. A write addressed to the `__default__` sentinel\nis a `404`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "stock", "locations", ":externalCode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "externalCode", "disabled": false, "description": { "content": "(Required) Stock-location external code (immutable, URL-safe).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "47668920-ce03-4a30-81d3-870e1b9d0a82", "name": "The updated location.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations", ":externalCode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Stock-location external code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalCode" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"external_code\": \"\",\n \"name\": \"\",\n \"is_active\": \"\",\n \"is_default\": \"\",\n \"pointofsale_tu_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33075c84-1b4d-41de-98f6-463e345ef98f", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations", ":externalCode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Stock-location external code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalCode" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6b2e0d8-9900-4748-b17d-fe11a779c888", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations", ":externalCode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Stock-location external code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalCode" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "623d4d30-12d8-4a5d-aab2-98b2d1c471a0", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations", ":externalCode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Stock-location external code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalCode" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a646e283-78f1-4e1f-bb0d-3a075156bc62", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations", ":externalCode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Stock-location external code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalCode" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9c98d8f-d196-43a9-a9c3-54a870e64288", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "locations", ":externalCode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Stock-location external code (immutable, URL-safe).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalCode" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "levels", "description": "", "item": [ { "id": "54c59aa8-c30b-412b-971f-b027473e646f", "name": "Flat stock-level view (full sync)", "request": { "name": "Flat stock-level view (full sync)", "description": { "content": "A flat, cross-product view of every stock level for the brand, for a\nPIM/ERP full sync. Requires `catalog.stock:read`. Filters: `sku` (exact,\nmatching the level's own stockable), `location` (external_code) and\n`updated_since` (on `source_updated_at`).\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "stock", "levels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "Location external_code.", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "326acf39-7f26-485c-a55c-673a9fc1620b", "name": "A page of stock levels.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "levels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "Location external_code.", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"product\": \"\",\n \"variant\": \"\",\n \"location\": \"\",\n \"source_updated_at\": \"\"\n },\n {\n \"quantity\": \"\",\n \"reserved\": \"\",\n \"available\": \"\",\n \"product\": \"\",\n \"variant\": \"\",\n \"location\": \"\",\n \"source_updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total\": \"\",\n \"last_page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b07d909-a802-4767-8604-686b65bf8255", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "levels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "Location external_code.", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c095cbe5-65a5-4571-aaec-4fb947128b07", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "levels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "Location external_code.", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e060e5c-dafe-4dd1-bbdc-04f5cfb1d438", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "levels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sku", "value": "" }, { "disabled": false, "description": { "content": "Location external_code.", "type": "text/plain" }, "key": "location", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "1-based page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page. Default 50; values above 200 are clamped to 200.", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "feeds", "description": "", "item": [ { "id": "2457b52a-aa79-498c-88cf-6d0769dc6267", "name": "Ingest a stock feed (snapshot)", "request": { "name": "Ingest a stock feed (snapshot)", "description": { "content": "Bulk stock ingestion. Requires `catalog.stock:ingest`. This surface uses\nthe existing feed idempotence mechanism, NOT the generic Idempotency-Key\nmiddleware: the **`Idempotency-Key` header is REQUIRED and folds into\n`source_batch_id`** (a missing header is a `422`, not a `400`).\nRe-posting the same batch id returns the existing feed unchanged\n(`200`); a new batch is queued for processing (`202`). Only snapshot\nmode is supported (`mode: delta` → `422`).\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "stock", "feeds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) The feed batch id (`source_batch_id`). Re-using it replays the same feed.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source\": \"\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"quantity\": \"\",\n \"location_code\": \"\",\n \"reserved\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"mode\": \"snapshot\",\n \"generated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c77394e0-7522-4786-aa11-8e70e643be07", "name": "The feed already existed for this batch id (replay); returned unchanged.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "feeds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) The feed batch id (`source_batch_id`). Re-using it replays the same feed.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source\": \"\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"quantity\": \"\",\n \"location_code\": \"\",\n \"reserved\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"mode\": \"snapshot\",\n \"generated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"feed_id\": \"\",\n \"status\": \"\",\n \"received_lines\": \"\",\n \"report_url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8fdea75-6d69-47a8-b28b-099559e1e3de", "name": "The feed was accepted and queued for processing.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "feeds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) The feed batch id (`source_batch_id`). Re-using it replays the same feed.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source\": \"\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"quantity\": \"\",\n \"location_code\": \"\",\n \"reserved\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"mode\": \"snapshot\",\n \"generated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"feed_id\": \"\",\n \"status\": \"\",\n \"received_lines\": \"\",\n \"report_url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14f99681-6bfa-4020-94e3-9661171996b8", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "feeds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) The feed batch id (`source_batch_id`). Re-using it replays the same feed.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source\": \"\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"quantity\": \"\",\n \"location_code\": \"\",\n \"reserved\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"mode\": \"snapshot\",\n \"generated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca9bbab0-9e0f-4294-8269-0c7a86966062", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "feeds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) The feed batch id (`source_batch_id`). Re-using it replays the same feed.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source\": \"\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"quantity\": \"\",\n \"location_code\": \"\",\n \"reserved\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"mode\": \"snapshot\",\n \"generated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cba90878-51de-418e-ae90-ef23a3289041", "name": "The request body or query failed validation.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "feeds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) The feed batch id (`source_batch_id`). Re-using it replays the same feed.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source\": \"\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"quantity\": \"\",\n \"location_code\": \"\",\n \"reserved\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"mode\": \"snapshot\",\n \"generated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "578e4bff-993f-486f-8958-95f5f301b0ff", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "feeds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) The feed batch id (`source_batch_id`). Re-using it replays the same feed.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source\": \"\",\n \"lines\": [\n {\n \"sku\": \"\",\n \"quantity\": \"\",\n \"location_code\": \"\",\n \"reserved\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"mode\": \"snapshot\",\n \"generated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{tuId}", "description": "", "item": [ { "id": "9c11edef-fa11-4559-863c-d29d44b768b1", "name": "Get a stock feed report", "request": { "name": "Get a stock feed report", "description": { "content": "The processing report for a feed the key's brand submitted. Readable by\nEITHER a `catalog.stock:read` OR a `catalog.stock:ingest` key (ANY-OF).\nThe `lines` block keeps its own `page`/`per_page` pagination\n(`per_page` default 100, cap 500).\n", "type": "text/plain" }, "url": { "path": [ "v1", "client", "catalog", "stock", "feeds", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lines per page (1–500, default 100).", "type": "text/plain" }, "key": "per_page", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" } ], "variable": [ { "type": "any", "value": "", "key": "tuId", "disabled": false, "description": { "content": "(Required) Stock-feed opaque id (`tu_id`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3b42e5ac-499f-475f-b1dc-7eb1064cb39d", "name": "The feed report.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "feeds", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lines per page (1–500, default 100).", "type": "text/plain" }, "key": "per_page", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Stock-feed opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"feed_id\": \"\",\n \"source\": \"\",\n \"status\": \"\",\n \"report_url\": \"\",\n \"lines\": {\n \"data\": [\n {\n \"sku\": \"\",\n \"location_code\": \"\",\n \"result\": \"\",\n \"message\": \"\"\n },\n {\n \"sku\": \"\",\n \"location_code\": \"\",\n \"result\": \"\",\n \"message\": \"\"\n }\n ],\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total\": \"\",\n \"last_page\": \"\",\n \"key_0\": \"string\",\n \"key_1\": 1786,\n \"key_2\": 9384.798415222394\n },\n \"totals\": {\n \"key_0\": 44.82118169768734,\n \"key_1\": false\n },\n \"received_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e87989cf-37de-4d58-b760-cb380f662b2e", "name": "Missing, malformed, expired or revoked key — or a `cfk_` feed token\npresented on this surface.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "feeds", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lines per page (1–500, default 100).", "type": "text/plain" }, "key": "per_page", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Stock-feed opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e71280e3-67fe-4b3a-b5ba-391580b0b4e2", "name": "The key is valid but lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "feeds", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lines per page (1–500, default 100).", "type": "text/plain" }, "key": "per_page", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Stock-feed opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db2ac499-1c13-4e45-af5b-41e553e384df", "name": "The resource does not exist or belongs to another brand.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "feeds", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lines per page (1–500, default 100).", "type": "text/plain" }, "key": "per_page", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Stock-feed opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44b8e027-87fd-4080-b93b-d6c68447fc08", "name": "A per-key (read/write) or per-brand rate limit was exceeded. Carries the\n`X-RateLimit-*` trio and `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "client", "catalog", "stock", "feeds", ":tuId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lines per page (1–500, default 100).", "type": "text/plain" }, "key": "per_page", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Stock-feed opaque id (`tu_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "tuId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "env", "value": "staging" }, { "key": "baseUrl", "value": "https://api.{{env}}.tolduntold.com" } ], "info": { "_postman_id": "07f62081-9276-4dfe-8914-d5674833f32a", "name": "ToldUntold Client API — Catalog", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Machine-to-machine REST API letting a brand's PIM/ERP/OMS manage its\nToldUntold catalog: products, variant axes, variants and stock.\n\n## Authentication\nBearer authentication with a `tuk_` Client API key\n(`tuk_<24hex>.`), issued by a ToldUntold super-admin. Legacy feed\ntokens (`cfk_`) are NOT valid on this surface and are rejected with `401`.\n\n## Conventions\n- **Errors** use a flat envelope `{ \"code\", \"message\", \"errors\"? }` where\n `code` is a stable machine-readable string.\n- **Lists** return `{ \"data\": [...], \"meta\": {...} }` with\n `page`/`per_page` pagination (`per_page` default 50, hard cap 200).\n Single objects are returned as a flat JSON body.\n- **Timestamps** are ISO-8601 strings.\n- **Rate limits** are advertised through `X-RateLimit-*` response headers.\n- **Idempotency**: mutating endpoints accept an `Idempotency-Key` header;\n it is REQUIRED on the endpoints whose creations cannot be de-duplicated by\n a database constraint (see each operation).\n\n## Tenancy\nEach key carries exactly one brand. Every resource is resolved within that\nbrand; a resource that belongs to another brand (or does not exist) is a\nflat `404 not_found`. There is no implicit cross-brand access.\n", "type": "text/plain" } } }