{ "info": { "name": "Elastic Path Commerce APIs", "description": "Complete API collection for Elastic Path Commerce Cloud, generated from OpenAPI specifications", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_postman_id": "ac3250ce-d6d5-49ec-9f56-bddb595f46fd" }, "item": [ { "name": "Accounts", "description": "An Account represents the entity that participates in a Commerce transaction. Accounts can have Carts, Orders, Subscriptions, and Addresses.\n", "item": [ { "id": "ceb42ae3-9239-4ef0-a58d-7bc4f43cb3ed", "name": "Create an Account", "request": { "name": "Create an Account", "description": { "content": "With the account creation endpoint, you have the ability to create accounts which can optionally have another account as a parent.", "type": "text/plain" }, "url": { "path": [ "v2", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "34c116e9-069d-4ce4-b869-18662a0c0964", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\",\n \"parent_id\": \"96b1f750-55d3-4768-a3f8-adffba694a2c\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"relationships\": {\n \"account_tags\": {\n \"data\": [\n {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n },\n {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n ]\n },\n \"ancestors\": [\n {\n \"data\": {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n },\n {\n \"data\": {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n }\n ],\n \"parent\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9afdef2b-e6aa-453d-becd-4e6bc1eb1634", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5482be41-0058-4488-9db7-b233febf72ea", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c705197d-9399-4105-a792-9d0e73937f06", "name": "Conflict", "originalRequest": { "url": { "path": [ "v2", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"account membership with the given account id and account member id already exists\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b35d8038-183c-428e-93a5-c4128d41cc22", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"store id mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51fb3e7e-1d53-4cab-8fe2-ab3a19bb50f2", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2c87fdf1-ae33-4d8b-b3ee-06e1606dc239", "name": "Get All Accounts", "request": { "name": "Get All Accounts", "description": { "content": "Use this endpoint to Get all accounts.\n\nYou can use pagination with this resource. For more information, see [pagination](/guides/Getting-Started/pagination).\n\n### Filtering\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) accounts:\n\n| Attribute | Operators | Example |\n|-------------------|-------------------------------|---------------------------------------------------------------|\n| `id` | `lt`,`le`,`eq`,`gt`,`ge`,`in` | `eq(id,3fa85f64-5717-4562-b3fc-2c963f66afa6)` |\n| `created_at` | `lt`,`le`,`eq`,`gt`,`ge` | `ge(created_at,2024-04-29T00:00:00.000Z)` |\n| `updated_at` | `lt`,`le`,`eq`,`gt`,`ge` | `le(updated_at,2024-04-29T00:00:00.000Z)` |\n| `name` | `eq`,`like` | `like(name,*swan*)` |\n| `legal_name` | `eq`,`like` | `like(legal_name,*swan*)` |\n| `registration_id` | `eq`,`like` | `like(registration_id,00000000-0000-1000-8000-*)` |\n| `external_ref` | `eq`,`like`,`in` | `like(external_ref,16be*)` |\n| `account_tags` | `contains` | `contains(account_tags,26beb787-be6e-40c3-bbae-9c645820b075)` |\n", "type": "text/plain" }, "url": { "path": [ "v2", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the order in which accounts will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,name,-name,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "36ceb190-6c87-4926-b01a-151777bc96e9", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the order in which accounts will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,name,-name,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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 \"type\": \"string\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\",\n \"parent_id\": \"96b1f750-55d3-4768-a3f8-adffba694a2c\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"relationships\": {\n \"account_tags\": {\n \"data\": [\n {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n },\n {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n ]\n },\n \"ancestors\": [\n {\n \"data\": {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n },\n {\n \"data\": {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n }\n ],\n \"parent\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\"\n }\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23\"\n }\n },\n {\n \"type\": \"string\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\",\n \"parent_id\": \"96b1f750-55d3-4768-a3f8-adffba694a2c\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"relationships\": {\n \"account_tags\": {\n \"data\": [\n {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n },\n {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n ]\n },\n \"ancestors\": [\n {\n \"data\": {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n },\n {\n \"data\": {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n }\n ],\n \"parent\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\"\n }\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23\"\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"limit\": 25,\n \"current\": 0,\n \"offset\": 0,\n \"total\": 1\n },\n \"results\": {\n \"total\": 1\n }\n },\n \"links\": {\n \"current\": \"http://kCTtMTFBiKUefweqgOZoqSSlSkIqnuqd.vjzNkW1pZOxQaaany.\",\n \"first\": \"http://NxVhFYDQmQFCJWiZB.hhvjivIQikeY5Z9++8LV.ACbDTJQJBryFt,PJ7t\",\n \"last\": \"http://clgmtJyMVdpP.rogaYvs,QgFLify3S4Lvy+,vaAZjjPMXwF519\",\n \"next\": \"string\",\n \"prev\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50b21b3f-8b3b-4975-8bc2-5692c3f7ec2f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the order in which accounts will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,name,-name,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b126b53-ce6e-4fbd-8677-9866fa7ac8f8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the order in which accounts will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,name,-name,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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 \"errors\": [\n {\n \"title\": \"Unauthorized\",\n \"status\": \"401\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70761ba4-38cf-4efc-9823-f243ae7a8a89", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the order in which accounts will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,name,-name,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30bbf8b8-0330-4e87-82e7-dc26004bb94f", "name": "Get an Account", "request": { "name": "Get an Account", "description": { "content": "View a specific account contained within your store", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID", "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7a46d25d-6d76-4855-858a-a75dd171c846", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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 \"type\": \"string\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\",\n \"parent_id\": \"96b1f750-55d3-4768-a3f8-adffba694a2c\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"relationships\": {\n \"account_tags\": {\n \"data\": [\n {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n },\n {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n ]\n },\n \"ancestors\": [\n {\n \"data\": {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n },\n {\n \"data\": {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n }\n ],\n \"parent\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f26f4bb9-a9ae-4211-9997-cda33b85f551", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b83df76-f5bf-41ce-8ba2-0a0f10cdada0", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "23d59508-b188-4618-a4d0-fa101b7bcc09", "name": "Update an Account", "request": { "name": "Update an Account", "description": { "content": "Update the information contained on an account.", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID", "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d5f8ded8-b4c3-437b-b40a-2d30360c0c55", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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 \"data\": {\n \"type\": \"account\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\",\n \"parent_id\": \"96b1f750-55d3-4768-a3f8-adffba694a2c\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"relationships\": {\n \"account_tags\": {\n \"data\": [\n {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n },\n {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n ]\n },\n \"ancestors\": [\n {\n \"data\": {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n },\n {\n \"data\": {\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"type\": \"string\"\n }\n }\n ],\n \"parent\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"http://WlNUXCXHVqjtPGJTJogybkZSv.nqxffPKE+vZeFoK+YICXHvo\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c847c2d9-d489-4b04-b6d6-8711afd2422f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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 \"data\": {\n \"type\": \"account\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n },\n {\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5de1170-2df1-46d9-9e50-5bbe3a1fca49", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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 \"data\": {\n \"type\": \"account\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"account not found\",\n \"status\": \"404\",\n \"title\": \"Not Found\"\n },\n {\n \"detail\": \"account not found\",\n \"status\": \"404\",\n \"title\": \"Not Found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ca6a2cf-4935-451a-a8d1-ff9dba138b1a", "name": "Conflict", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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 \"data\": {\n \"type\": \"account\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"account membership with the given account id and account member id already exists\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94241d52-5533-4ec0-88e2-f2e71b4b0375", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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 \"data\": {\n \"type\": \"account\",\n \"name\": \"acc-name\",\n \"legal_name\": \"acc-legal-name\",\n \"registration_id\": \"reg-id\",\n \"external_ref\": \"ext-ref\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5aaf6493-fa4f-48e5-acd9-7aea99634620", "name": "Delete an Account", "request": { "name": "Delete an Account", "description": { "content": "Delete a specific account within a store", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID", "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "20f09876-3edd-457f-8a17-526a35a48b98", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "a01b681a-a6da-405e-bfe6-ab65be84f00c", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19a91282-925b-4a70-8f1c-78dc09cfb823", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55efa59c-c361-46f2-9157-70b93d205fb6", "name": "Get an Account's Tags Relationship", "request": { "name": "Get an Account's Tags Relationship", "description": { "content": "Get a list of Account Tags on an Account", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID", "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1e74743d-9585-4209-bd8a-c664201428d5", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"string\"\n },\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"string\"\n }\n ],\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/relationships/account-tags\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae21d288-191a-44f9-a214-3f8e9ef1cad4", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c826215-2eeb-41d9-ba15-0e2e015569f1", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c5b8317-c252-4728-9dfc-1be8a91c807f", "name": "Add Account Tags", "request": { "name": "Add Account Tags", "description": { "content": "Add Account Tags onto an Account. Please note that after adding a tag to an account, the account member token should be regenerated to reflect the updated account status, allowing other services to react accordingly. See [Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens).", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID", "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"account_tag\",\n \"id\": \"030693ce-39ad-4f4c-9941-d2d596478e94\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a41f5c73-b83d-48ec-b7a4-30d8dd0b7c57", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"account_tag\",\n \"id\": \"030693ce-39ad-4f4c-9941-d2d596478e94\"\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\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"string\"\n },\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"string\"\n }\n ],\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/relationships/account-tags\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a63b0ada-18e6-478c-9cbf-15bd22f6c9f0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"account_tag\",\n \"id\": \"030693ce-39ad-4f4c-9941-d2d596478e94\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d05c368-4ebd-4884-8f9c-5f839bc35ef2", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"account_tag\",\n \"id\": \"030693ce-39ad-4f4c-9941-d2d596478e94\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ef8cce8-70d1-4d56-aa01-703d96df9189", "name": "Conflict", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"account_tag\",\n \"id\": \"030693ce-39ad-4f4c-9941-d2d596478e94\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"account membership with the given account id and account member id already exists\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49e7aca0-fa5b-4961-a585-95b67ceedb36", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"account_tag\",\n \"id\": \"030693ce-39ad-4f4c-9941-d2d596478e94\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5fd0e072-a95b-4f4f-99d9-b9f427e57458", "name": "Remove Account Tags", "request": { "name": "Remove Account Tags", "description": { "content": "Remove Account Tags from an Account. Please note that after removing a tag from an account, the account member token should be regenerated to reflect the updated status, allowing other services to react accordingly. See [Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens).", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID", "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"account_tag\",\n \"id\": \"030693ce-39ad-4f4c-9941-d2d596478e94\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4c169ed3-2ed7-4b39-a7d5-0e885eb24acf", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"account_tag\",\n \"id\": \"030693ce-39ad-4f4c-9941-d2d596478e94\"\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\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"string\"\n },\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"string\"\n }\n ],\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/relationships/account-tags\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4736da3a-d762-4194-93cb-7cdc56961f6f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"account_tag\",\n \"id\": \"030693ce-39ad-4f4c-9941-d2d596478e94\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f954466-d14f-4855-97a3-381a6421037e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"account_tag\",\n \"id\": \"030693ce-39ad-4f4c-9941-d2d596478e94\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3406c5a0-df24-4ac0-9bf5-e1dacc2a2f37", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "relationships", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"account_tag\",\n \"id\": \"030693ce-39ad-4f4c-9941-d2d596478e94\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account Members", "description": "An `Account Member` resource is a user that you can add to accounts using account memberships.\n\nAccount members API is read only, and you cannot add users using this API. There is a 1 to 1 correspondence between User Authentication Info and an Account Member, the corresponding objects have the same id. You must use the `user_authentication_info` object to create users in the authentication realm of account authentication settings. For more information on adding account members, see the [Adding Accounts and Account Members](/guides/How-To/Accounts/add-account-and-member) section.\n", "item": [ { "id": "e8de0f6c-6f0e-4a94-800d-4e4229344e62", "name": "Get all Account Members", "request": { "name": "Get all Account Members", "description": { "content": "Get all account members contained within your store.\n\n ### Filtering\n\n\n The following operators and attributes are available for\n[filtering](/guides/Getting-Started/filtering) account members.\n\n| Attribute | Type | Operator | Example | | :--- | :--- | :--- | :--- | | `email` | `string` | `ilike` | `ilike(email,'ronswanson@example.com')` | | `name` | `string` | `ilike` | `ilike(name,'*swan*')` | | `given_name` | `string` | `ilike`/`is_null` | `ilike(given_name,'ron*')` | | `middle_name` | `string` | `ilike`/`is_null` | `is_null(middle_name)` | | `family_name` | `string` | `ilike`/`is_null` | `is_null(family_name)` |\n", "type": "text/plain" }, "url": { "path": [ "v2", "account-members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Specifies the order in which account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,email,-email,id,-id,name,-name,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c0f7b725-9155-4385-8b64-c3d505c53b22", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "account-members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Specifies the order in which account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,email,-email,id,-id,name,-name,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"given_name\": \"Ron\",\n \"middle_name\": \"Ulysses\",\n \"family_name\": \"Swanson\",\n \"email\": \"ron@swanson.com\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account-members/908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n },\n {\n \"id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"given_name\": \"Ron\",\n \"middle_name\": \"Ulysses\",\n \"family_name\": \"Swanson\",\n \"email\": \"ron@swanson.com\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account-members/908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"limit\": 25,\n \"current\": 0,\n \"offset\": 0,\n \"total\": 1\n },\n \"results\": {\n \"total\": 1\n }\n },\n \"links\": {\n \"current\": \"http://xGINkVJJhqhgxEjmHuxtAoRC.mvPDyNrtsYDmFps+9B,KrOM-kMP,a\",\n \"first\": \"http://IcYmoqpvdggOIrIO.hfoLVSLeBzKll,5RZA6lXLWbguAnEfA\",\n \"last\": \"https://pzcxav.ebi9lyUGVMMBQ5Im5gMR,3xr.nOTvIydEUTamR9PAKK07Fh2TW3+biR5biiYmBfhT6lAuI3t\",\n \"next\": \"string\",\n \"prev\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "794a388f-8a61-4762-844a-07438de3b299", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "account-members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Specifies the order in which account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,email,-email,id,-id,name,-name,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fb9e6c8-f411-4336-898d-47bb70447dae", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "account-members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Specifies the order in which account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,email,-email,id,-id,name,-name,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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 \"errors\": [\n {\n \"title\": \"Unauthorized\",\n \"status\": \"401\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c769c2e-3fdb-4aac-9738-8df49270d647", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "account-members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Specifies the order in which account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,email,-email,id,-id,name,-name,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06f581b8-a1ca-4875-9cff-03e516b18369", "name": "Get an Account Member", "request": { "name": "Get an Account Member", "description": { "content": "Get an account member from your store", "type": "text/plain" }, "url": { "path": [ "v2", "account-members", ":accountMemberID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberID", "disabled": false, "description": { "content": "(Required) The unique identifier of the account member that you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7f00ec3d-94ed-4a97-9b49-45989f3f13e4", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "account-members", ":accountMemberID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account member that you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberID" } ] }, "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 \"id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"given_name\": \"Ron\",\n \"middle_name\": \"Ulysses\",\n \"family_name\": \"Swanson\",\n \"email\": \"ron@swanson.com\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account-members/908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account-members/deb6b25f-8451-4211-9a22-95610333df23\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "942c4a1e-172d-4b7d-96ca-f72f6fb937ac", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "account-members", ":accountMemberID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account member that you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "326057a9-61aa-4c7b-99c8-b6c787f6520e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "account-members", ":accountMemberID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account member that you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d53f7778-5ac4-403d-a32f-681804a3f6bd", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "account-members", ":accountMemberID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account member that you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7866d763-866e-4cc5-b6b0-00e6c9e31809", "name": "Update an account member", "request": { "name": "Update an account member", "description": { "content": "This endpoint can be used to update an account member.", "type": "text/plain" }, "url": { "path": [ "v2", "account-members", ":accountMemberID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberID", "disabled": false, "description": { "content": "(Required) The unique identifier of the account member that you want to update the flows of.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_member\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "29f05d6f-5ef3-4e11-b7d9-707841277bae", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "account-members", ":accountMemberID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account member that you want to update the flows of.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberID" } ] }, "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 \"data\": {\n \"type\": \"account_member\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"given_name\": \"Ron\",\n \"middle_name\": \"Ulysses\",\n \"family_name\": \"Swanson\",\n \"email\": \"ron@swanson.com\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account-members/908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account-members/908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fd09881-15f9-4ec0-aa8c-358970617048", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "account-members", ":accountMemberID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account member that you want to update the flows of.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberID" } ] }, "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 \"data\": {\n \"type\": \"account_member\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94db07ec-ac12-4061-be6d-0a41a982d8f5", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "account-members", ":accountMemberID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account member that you want to update the flows of.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberID" } ] }, "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 \"data\": {\n \"type\": \"account_member\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8efcc51-235a-4c10-bb61-90a8ea6d982d", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "account-members", ":accountMemberID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account member that you want to update the flows of.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberID" } ] }, "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 \"data\": {\n \"type\": \"account_member\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account Membership", "description": "The `Account Membership` resource represents the relationship between an account and an account member. This relationship is many to many. Each account can have multiple account members, and each account member can be a member of multiple accounts.", "item": [ { "id": "a0b6501a-7937-49c2-acc3-d9bd6f2ac387", "name": "Create an Account Membership", "request": { "name": "Create an Account Membership", "description": { "content": ":::caution\n\nYou can only create up to 1000 account memberships in an account.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID", "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account is associated with.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_membership\",\n \"account_member_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "53642578-7830-4a1b-8af0-468f941ea93b", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_membership\",\n \"account_member_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"24e939f6-178f-497b-9d64-5bf2b5a70a2e\",\n \"type\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"relationships\": {\n \"account_member\": {\n \"data\": {\n \"id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"type\": \"string\"\n }\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships/24e939f6-178f-497b-9d64-5bf2b5a70a2e\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/account-memberships/5ac48b3b-825d-43a3-9fcd-962230629d5e\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebd67061-8011-4345-a8fa-e77b50786489", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_membership\",\n \"account_member_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a87e2208-0bbf-43cb-b66a-1486ec439d5a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_membership\",\n \"account_member_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf4447f3-58d0-4ae3-8164-881af2fe3707", "name": "Conflict", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_membership\",\n \"account_member_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"account membership with the given account id and account member id already exists\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82cbf3b0-0adb-4d99-988f-415bf9d2770a", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_membership\",\n \"account_member_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"store id mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c0f271e-27ad-4cf9-9b61-da595f22a343", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_membership\",\n \"account_member_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b4c79fb-e6bf-4260-bac0-a4eb5799eda5", "name": "Get all Account Memberships", "request": { "name": "Get all Account Memberships", "description": { "content": "You can also use `include=account_member` to retrieve details about the account members associated with the account memberships. With this option, you can get more information about the account members such as name and email in a single request. For more information see [including resources](/guides/Getting-Started/includes).\n\n### Filtering\n\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) account memberships.\n\n| Operator | Description |\n| :--- | :--- |\n| `eq` | Checks whether the values of two operands are equal. If the values are equal, the condition is true. |\n| `like` | Checks if the operand contains the specified string. You can use wildcard characters in operand. |\n\n| Attribute | Type | Operator | Example |\n| :--- | :--- | :--- | :--- |\n| `account_member_id` | `string` | `eq` / `like` | `eq(account_member_id,00000000-0000-1000-8000-0000000)` |", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like account members.", "type": "text/plain" }, "key": "include", "value": "account_member" }, { "disabled": false, "description": { "content": "Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,updated_at,-updated_at,id,-id)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID", "disabled": false, "description": { "content": "(Required) The ID of the account for which you want to get the list of unassigned account members.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3cd84a94-41ea-41c9-98d4-c38e3166abd6", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like account members.", "type": "text/plain" }, "key": "include", "value": "account_member" }, { "disabled": false, "description": { "content": "Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,updated_at,-updated_at,id,-id)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account for which you want to get the list of unassigned account members.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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\": \"24e939f6-178f-497b-9d64-5bf2b5a70a2e\",\n \"type\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"relationships\": {\n \"account_member\": {\n \"data\": {\n \"id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"type\": \"string\"\n }\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships/24e939f6-178f-497b-9d64-5bf2b5a70a2e\"\n },\n \"account_member_id\": \"deb6b25f-8451-4211-9a22-95610333df23\"\n },\n {\n \"id\": \"24e939f6-178f-497b-9d64-5bf2b5a70a2e\",\n \"type\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"relationships\": {\n \"account_member\": {\n \"data\": {\n \"id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"type\": \"string\"\n }\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships/24e939f6-178f-497b-9d64-5bf2b5a70a2e\"\n },\n \"account_member_id\": \"deb6b25f-8451-4211-9a22-95610333df23\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"limit\": 25,\n \"current\": 0,\n \"offset\": 0,\n \"total\": 1\n },\n \"results\": {\n \"total\": 1\n }\n },\n \"links\": {\n \"current\": \"https://UNnTXAq.lsnwxZUS\",\n \"first\": \"https://JlVujW.zsyraNZjO7WAnfnubH+-t6+k98s+7lcTeX,SU5kCqDbhfkRYttE0\",\n \"last\": \"https://PYLizJ.qnijyhVlMl8lM0rayLemperP7PRTjUlFeiGD\",\n \"next\": \"string\",\n \"prev\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c71aee73-2c5d-4086-ba13-c93e787b234f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like account members.", "type": "text/plain" }, "key": "include", "value": "account_member" }, { "disabled": false, "description": { "content": "Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,updated_at,-updated_at,id,-id)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account for which you want to get the list of unassigned account members.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22dc25ae-b86f-4f9b-95df-521f438f0260", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like account members.", "type": "text/plain" }, "key": "include", "value": "account_member" }, { "disabled": false, "description": { "content": "Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,updated_at,-updated_at,id,-id)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account for which you want to get the list of unassigned account members.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b982ade-bb47-4bf8-a01e-fbb4c612898d", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like account members.", "type": "text/plain" }, "key": "include", "value": "account_member" }, { "disabled": false, "description": { "content": "Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,updated_at,-updated_at,id,-id)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account for which you want to get the list of unassigned account members.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "735e0099-329b-4ac8-ab8f-b3828a7c7154", "name": "Get a List of Account Memberships of Account Member", "request": { "name": "Get a List of Account Memberships of Account Member", "description": { "content": "You can also use `include=account` to retrieve details about the accounts associated with the account memberships. For more information see [including resources](/guides/Getting-Started/includes).\n\nYou can use pagination with this resource. For more information, see [pagination](/guides/Getting-Started/pagination).\n\n### Filtering\n\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) account memberships.\n\n| Operator | Description |\n| :--- | :--- |\n| `eq` | Checks whether the values of two operands are equal. If the values are equal, the condition is true. |\n| `like` | Checks if the operand contains the specified string. You can use wildcard characters in operand. |\n\n| Attribute | Type | Operator | Example |\n| :--- | :--- | :--- | :--- |\n| `account_member_id` | `string` | `eq` / `like` | `eq(account_member_id,00000000-0000-1000-8000-0000000)` |\n", "type": "text/plain" }, "url": { "path": [ "v2", "account-members", ":accountMemberId", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like accounts.", "type": "text/plain" }, "key": "include", "value": "account" }, { "disabled": false, "description": { "content": "Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "-created_at" } ], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberId", "disabled": false, "description": { "content": "(Required) The ID of the account member for which you want to list the memberships.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "af9948d3-5574-444d-9857-ca3bd8032a2f", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "account-members", ":accountMemberId", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like accounts.", "type": "text/plain" }, "key": "include", "value": "account" }, { "disabled": false, "description": { "content": "Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "-created_at" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account member for which you want to list the memberships.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberId" } ] }, "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\": \"24e939f6-178f-497b-9d64-5bf2b5a70a2e\",\n \"type\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"relationships\": {\n \"account\": {\n \"data\": {\n \"id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"type\": \"string\"\n }\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships/24e939f6-178f-497b-9d64-5bf2b5a70a2e\"\n },\n \"account_member_id\": \"deb6b25f-8451-4211-9a22-95610333df23\"\n },\n {\n \"id\": \"24e939f6-178f-497b-9d64-5bf2b5a70a2e\",\n \"type\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"relationships\": {\n \"account\": {\n \"data\": {\n \"id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"type\": \"string\"\n }\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships/24e939f6-178f-497b-9d64-5bf2b5a70a2e\"\n },\n \"account_member_id\": \"deb6b25f-8451-4211-9a22-95610333df23\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"limit\": 25,\n \"current\": 0,\n \"offset\": 0,\n \"total\": 1\n },\n \"results\": {\n \"total\": 1\n }\n },\n \"links\": {\n \"current\": \"http://YoKHMrsAjXeMiullpGEVoLqJLSxEqYLDo.vdneQAQgD8d,ZsXDGhZkGlkjNcNSjW3Qn0kdv3oMV\",\n \"first\": \"https://wcIreWwZKDeVbIbzuj.kevrU8ZZOse8Iw2D3djh\",\n \"last\": \"http://OizkihzAquQWQI.irnpEJKylYqF,DO5TXyORxC\",\n \"next\": \"string\",\n \"prev\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cd0b960-b419-41f3-b8b0-7389207975c5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "account-members", ":accountMemberId", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like accounts.", "type": "text/plain" }, "key": "include", "value": "account" }, { "disabled": false, "description": { "content": "Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "-created_at" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account member for which you want to list the memberships.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "946c78da-89e5-42fa-8bdd-ce98c515f774", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "account-members", ":accountMemberId", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like accounts.", "type": "text/plain" }, "key": "include", "value": "account" }, { "disabled": false, "description": { "content": "Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "-created_at" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account member for which you want to list the memberships.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ea98f6b-2b2d-47fe-820e-03f0ab13d9ad", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "account-members", ":accountMemberId", "account-memberships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like accounts.", "type": "text/plain" }, "key": "include", "value": "account" }, { "disabled": false, "description": { "content": "Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "-created_at" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account member for which you want to list the memberships.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountMemberId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b635ab91-0bee-4467-bf18-487402873996", "name": "Get a List of Unassigned Account Members", "request": { "name": "Get a List of Unassigned Account Members", "description": { "content": "Use this resource to get a list of all account members that are not assigned to an account.\n\n### Filtering\n\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) unassigned account members.\n\n| Operator | Description |\n| :------- | :--------------------------------------------------------------------------------------------------- |\n| `eq` | Checks whether the values of two operands are equal. If the values are equal, the condition is true. |\n| `like` | Checks if the operand contains the specified string. You can use wildcard characters in operand. |\n\n| Attribute | Type | Operator | Example |\n| :-------- | :------- | :------------ | :--------------------------------- |\n| `email` | `string` | `eq` / `like` | `eq(email,ronswanson@example.com)` |\n| `name` | `string` | `eq` / `like` | `like(name,*swan*)` |\n\n:::note\n\nYou can use pagination with this resource. For more information, see [pagination](/guides/Getting-Started/pagination).\n\n:::", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", "unassigned-account-members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Specifies the order in which unassigned account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,updated_at,updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID", "disabled": false, "description": { "content": "(Required) The ID of the account for which you want to get the list of unassigned account members.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "36885f2a-cbfc-49ae-a372-e86985702bd3", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", "unassigned-account-members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Specifies the order in which unassigned account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,updated_at,updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account for which you want to get the list of unassigned account members.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"given_name\": \"Ron\",\n \"middle_name\": \"Ulysses\",\n \"family_name\": \"Swanson\",\n \"email\": \"ron@swanson.com\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account-members/908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n },\n {\n \"id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"given_name\": \"Ron\",\n \"middle_name\": \"Ulysses\",\n \"family_name\": \"Swanson\",\n \"email\": \"ron@swanson.com\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account-members/908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"limit\": 25,\n \"current\": 0,\n \"offset\": 0,\n \"total\": 1\n },\n \"results\": {\n \"total\": 1\n }\n },\n \"links\": {\n \"current\": \"http://TLMtJAUOJHRnpGyBBNmtiE.cbnu6k4bTOlMWP0F,KRHgLi0cqqdQ,xVqs,CWf6qVakPFzPRg\",\n \"first\": \"http://wgWufuvas.gwAU7zovFHdd0FtqD3gR5KkX1OtoBufZ\",\n \"last\": \"https://VGO.jehHFmZZxJqYzKmZ.J2+glbGWtaAP926H6\",\n \"next\": \"string\",\n \"prev\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94f467ec-a21b-49b0-927d-86397f4f5d63", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", "unassigned-account-members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Specifies the order in which unassigned account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,updated_at,updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account for which you want to get the list of unassigned account members.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "242d7ba5-d8b6-48d2-abd3-b9af68cc826e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", "unassigned-account-members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Specifies the order in which unassigned account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,updated_at,updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account for which you want to get the list of unassigned account members.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "581411af-4272-409d-be57-b9713c145f10", "name": "Conflict", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", "unassigned-account-members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Specifies the order in which unassigned account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,updated_at,updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account for which you want to get the list of unassigned account members.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"account membership with the given account id and account member id already exists\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8a7163b-f426-44cb-b6b5-a9ed8009fa3a", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", "unassigned-account-members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "Specifies the order in which unassigned account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,updated_at,updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account for which you want to get the list of unassigned account members.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b904319-179e-43b0-8fe2-77e87321fbfb", "name": "Get an Account Membership", "request": { "name": "Get an Account Membership", "description": { "content": "Get an account membership from an account in your store.\n\nYou can also use `include=account_member` to retrieve details about the account member associated with this account membership. With this option, you can get more information about the account member such as name and email in a single request. For more information see [including resources](/guides/Getting-Started/includes).\n", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like account members.", "type": "text/plain" }, "key": "include", "value": "account_member" } ], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID", "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" } }, { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID", "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "48d1b1fb-221d-485a-b61b-fe5eeaa6aa73", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like account members.", "type": "text/plain" }, "key": "include", "value": "account_member" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID" } ] }, "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 \"id\": \"24e939f6-178f-497b-9d64-5bf2b5a70a2e\",\n \"type\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"relationships\": {\n \"account_member\": {\n \"data\": {\n \"id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"type\": \"string\"\n }\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships/24e939f6-178f-497b-9d64-5bf2b5a70a2e\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/account-memberships/5ac48b3b-825d-43a3-9fcd-962230629d5e\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03c582a9-20e0-4bcc-b3da-4e44bded89ea", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like account members.", "type": "text/plain" }, "key": "include", "value": "account_member" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d9a6357-563f-49d6-9dc1-81eee39c3fdb", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Parameter to retrieve more information about any related resources like account members.", "type": "text/plain" }, "key": "include", "value": "account_member" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "842a31cd-897b-4311-b519-935914339e79", "name": "Update an Account Membership", "request": { "name": "Update an Account Membership", "description": { "content": "You can update and extend an account member details using [core flows](/docs/api/flows/flows#extend-an-existing-resource). However, you cannot update the `account_member_id` of an account member.", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID", "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" } }, { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID", "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_membership\",\n \"account_member_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2b0740e3-82c4-46a6-b388-fa6667cb4d61", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID" } ] }, "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 \"data\": {\n \"type\": \"account_membership\",\n \"account_member_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"24e939f6-178f-497b-9d64-5bf2b5a70a2e\",\n \"type\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"relationships\": {\n \"account_member\": {\n \"data\": {\n \"id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"type\": \"string\"\n }\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships/24e939f6-178f-497b-9d64-5bf2b5a70a2e\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/account-memberships/5ac48b3b-825d-43a3-9fcd-962230629d5e\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e621e34-7d5e-4eab-9e70-88e36b9e68dc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID" } ] }, "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 \"data\": {\n \"type\": \"account_membership\",\n \"account_member_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fb89bbc-a0d8-44c1-b2d6-964ac69f94f6", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID" } ] }, "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 \"data\": {\n \"type\": \"account_membership\",\n \"account_member_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a16b1eff-d659-491b-aa86-03b9e3aec754", "name": "Conflict", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID" } ] }, "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 \"data\": {\n \"type\": \"account_membership\",\n \"account_member_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"account membership with the given account id and account member id already exists\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c7e31aa-4a93-4f80-847b-92bb4c59cf55", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID" } ] }, "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 \"data\": {\n \"type\": \"account_membership\",\n \"account_member_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e38e6d1a-71ef-4d10-906b-dbaceb4bf6ff", "name": "Delete an Account Membership", "request": { "name": "Delete an Account Membership", "description": { "content": "Delete a membership from an account", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID", "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" } }, { "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID", "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d1b3b780-6da1-41e3-806f-ae623efc954c", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID" } ] }, "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": "37abe0e2-09ab-4c6f-93ca-8655125e2968", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c3b6f54-a52a-4db0-9925-22d5a126892f", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "account-memberships", ":membershipID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the account that the account member is associated with.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the account membership to update the details of the account member.", "type": "text/plain" }, "type": "any", "value": "1c53d37d-0d46-18cb-e869-b28986b992ca", "key": "membershipID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account Membership Settings", "description": "Account Membership Settings allow Account Members to be associated to, at most, N accounts at a time. You can set this value to any number up to 10,000. The default value is 10,000.\n\nThis setting is only applied to new account memberships. If an account member is added to 3 accounts, and the setting is reduced to 1, the account member remains in the 3 accounts and can no longer be added to more.\n", "item": [ { "id": "5b1cda2c-6f8a-4f8f-8437-2cce1fe8a252", "name": "Get Account Membership Settings", "request": { "name": "Get Account Membership Settings", "description": { "content": "Use this endpoint to get all account membership settings.", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "account-membership" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f5820917-593d-45d3-b695-cbd15ab2340a", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "settings", "account-membership" ], "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" } ], "body": "{\n \"data\": {\n \"type\": \"account_membership_setting\",\n \"membership_limit\": 100\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e3919c9-ae2c-437c-b8c5-4c59a190182f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "settings", "account-membership" ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "262862b0-229d-48f9-8424-2a237dd936d6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "settings", "account-membership" ], "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 \"errors\": [\n {\n \"title\": \"Unauthorized\",\n \"status\": \"401\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c15012e7-6b95-4540-9912-8cde65135500", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "settings", "account-membership" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "35119122-f340-4453-9da4-79d1210780bc", "name": "Update Account Membership Settings", "request": { "name": "Update Account Membership Settings", "description": { "content": "Use this endpoint to update account membership settings.", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "account-membership" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_membership_setting\",\n \"membership_limit\": 1000\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e4cbf5a0-340f-4ac3-9d18-c2548c66db99", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "settings", "account-membership" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"type\": \"account_membership_setting\",\n \"membership_limit\": 1000\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"account_membership_setting\",\n \"membership_limit\": 100\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28872e37-da92-4dab-bdd3-91c87244e8a3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "settings", "account-membership" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"type\": \"account_membership_setting\",\n \"membership_limit\": 1000\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "205cdc0f-2497-4ff4-b400-62b940d9c4b2", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "settings", "account-membership" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"type\": \"account_membership_setting\",\n \"membership_limit\": 1000\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account Management Authentication", "description": "Commerce provides authentication tokens for an `Account` and an `Account Member`.", "item": [ { "id": "8f4b0aa2-b18e-481d-8b42-7478ccf85838", "name": "Generate an Account Management Authentication Token", "request": { "name": "Generate an Account Management Authentication Token", "description": { "content": "Commerce provides authentication tokens for anyone using the Account Management APIs, including accounts and account members.\n\nFor each element in the list returned by the account member authentication API, a token value is returned. In order for a shopper to authenticate as the account, this value should be set as the `EP-Account-Management-Authentication-Token` header when calling Commerce. This header grants access to additional resources associated with the account, such as [carts](/docs/api/carts/account-cart-associations), [orders](/docs/api/carts/orders), [catalogs with associated rules](/docs/api/pxm/catalog/rules), and [addresses](/docs/api/addresses/addresses-introduction).\n\nThe set of permissions available to a shopper using an Account Management Authentication token is documented in [Permissions](/docs/authentication/tokens/permissions)\n\nCommerce provides authentication tokens for an account and an account member using:\n\n- OpenID Connect\n- Username and password\n- Self signup\n- One-time password token\n- Switch account token\n", "type": "text/plain" }, "url": { "path": [ "v2", "account-members", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_management_authentication_token\",\n \"authentication_mechanism\": \"oidc\",\n \"oauth_authorization_code\": \"c2490f06-6d8e-4927-99aa-4bf02b419e96\",\n \"oauth_redirect_uri\": \"https://example-store.com/oauth2/callback\",\n \"oauth_code_verifier\": \"0E934PurR8ExVg6Pj7T4kQewxKzWSfSFG5d15FGfww8\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3a3f65c4-b473-4673-b54c-2719b2a74b04", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "account-members", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_management_authentication_token\",\n \"authentication_mechanism\": \"oidc\",\n \"oauth_authorization_code\": \"c2490f06-6d8e-4927-99aa-4bf02b419e96\",\n \"oauth_redirect_uri\": \"https://example-store.com/oauth2/callback\",\n \"oauth_code_verifier\": \"0E934PurR8ExVg6Pj7T4kQewxKzWSfSFG5d15FGfww8\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"type\": \"string\",\n \"account_name\": \"acc-name-1\",\n \"account_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOiIyMDIxLTAzLTE2VDE5OjM2OjExLjA3MFoiLCJpYXQiOiIyMDIxLTAzLTE1VDE5OjM2OjExLjA3MFoiLCJzY29wZSI6IjFjNDVlNGVjLTI2ZTAtNDA0My04NmU0LWMxNWI5Y2Y5ODVhMyIsInN1YiI6IjFjNDVlNGVjLTI2ZTAtNDA0My04NmU0LWMxNWI5Y2Y5ODVhMiJ9.ytQ3UutTl_RJ8NiB1xN29Ta23p-FXsYOhcUM7MUQ4CM\",\n \"expires\": \"2021-03-16T19:36:11.070Z\"\n },\n {\n \"type\": \"string\",\n \"account_name\": \"acc-name-1\",\n \"account_id\": \"908f7849-60da-4e4a-a3b1-51d4cbe3b953\",\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOiIyMDIxLTAzLTE2VDE5OjM2OjExLjA3MFoiLCJpYXQiOiIyMDIxLTAzLTE1VDE5OjM2OjExLjA3MFoiLCJzY29wZSI6IjFjNDVlNGVjLTI2ZTAtNDA0My04NmU0LWMxNWI5Y2Y5ODVhMyIsInN1YiI6IjFjNDVlNGVjLTI2ZTAtNDA0My04NmU0LWMxNWI5Y2Y5ODVhMiJ9.ytQ3UutTl_RJ8NiB1xN29Ta23p-FXsYOhcUM7MUQ4CM\",\n \"expires\": \"2021-03-16T19:36:11.070Z\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"limit\": 25,\n \"current\": 0,\n \"offset\": 0,\n \"total\": 1\n },\n \"results\": {\n \"total\": 1\n },\n \"account_member_id\": \"f5d08d48-bbc8-4f61-818f-a78583045f56\"\n },\n \"links\": {\n \"current\": \"http://uqTumGlL.fllfYSJXKsX6ywVe5Dd+7uq5DgiJ8KePJXOe-qaLqh\",\n \"first\": \"https://FMduAYFGYcCQxLlWncBcISORFzcn.wwowwbzsgX1ZFef4PohqRc+79hbUo6PGDPAnsKkOfrESVjUhkYBBHgkboBVx1gqOuPtv\",\n \"last\": \"https://u.hvE.9.lYTixcNfOo6Du6hs\",\n \"next\": \"string\",\n \"prev\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "518b9539-b7e5-490b-bb9e-b5a403cdb86d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "account-members", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_management_authentication_token\",\n \"authentication_mechanism\": \"oidc\",\n \"oauth_authorization_code\": \"c2490f06-6d8e-4927-99aa-4bf02b419e96\",\n \"oauth_redirect_uri\": \"https://example-store.com/oauth2/callback\",\n \"oauth_code_verifier\": \"0E934PurR8ExVg6Pj7T4kQewxKzWSfSFG5d15FGfww8\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b95fedd-9dd8-4964-a43d-2f4437510cac", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "account-members", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_management_authentication_token\",\n \"authentication_mechanism\": \"oidc\",\n \"oauth_authorization_code\": \"c2490f06-6d8e-4927-99aa-4bf02b419e96\",\n \"oauth_redirect_uri\": \"https://example-store.com/oauth2/callback\",\n \"oauth_code_verifier\": \"0E934PurR8ExVg6Pj7T4kQewxKzWSfSFG5d15FGfww8\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Unauthorized\",\n \"status\": \"401\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdf02768-c360-4e61-abcf-1741e0736c23", "name": "Forbidden Error", "originalRequest": { "url": { "path": [ "v2", "account-members", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_management_authentication_token\",\n \"authentication_mechanism\": \"oidc\",\n \"oauth_authorization_code\": \"c2490f06-6d8e-4927-99aa-4bf02b419e96\",\n \"oauth_redirect_uri\": \"https://example-store.com/oauth2/callback\",\n \"oauth_code_verifier\": \"0E934PurR8ExVg6Pj7T4kQewxKzWSfSFG5d15FGfww8\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"forbidden\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "288d4751-76c2-4b32-add6-371ba87bbef5", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "account-members", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_management_authentication_token\",\n \"authentication_mechanism\": \"oidc\",\n \"oauth_authorization_code\": \"c2490f06-6d8e-4927-99aa-4bf02b419e96\",\n \"oauth_redirect_uri\": \"https://example-store.com/oauth2/callback\",\n \"oauth_code_verifier\": \"0E934PurR8ExVg6Pj7T4kQewxKzWSfSFG5d15FGfww8\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e05a6fd1-cfb7-4596-96a9-70993626a8cd", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "account-members", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_management_authentication_token\",\n \"authentication_mechanism\": \"oidc\",\n \"oauth_authorization_code\": \"c2490f06-6d8e-4927-99aa-4bf02b419e96\",\n \"oauth_redirect_uri\": \"https://example-store.com/oauth2/callback\",\n \"oauth_code_verifier\": \"0E934PurR8ExVg6Pj7T4kQewxKzWSfSFG5d15FGfww8\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"store id mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcdb8384-2885-4dd7-8338-cb2b73c632d6", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "account-members", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_management_authentication_token\",\n \"authentication_mechanism\": \"oidc\",\n \"oauth_authorization_code\": \"c2490f06-6d8e-4927-99aa-4bf02b419e96\",\n \"oauth_redirect_uri\": \"https://example-store.com/oauth2/callback\",\n \"oauth_code_verifier\": \"0E934PurR8ExVg6Pj7T4kQewxKzWSfSFG5d15FGfww8\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account Authentication Settings", "description": "You can use the Account Authentication Settings endpoint to retrieve or modify how settings controlling account and account member authentication.", "item": [ { "id": "b796cf94-48ee-4177-8b5d-d8ab2bd7b97f", "name": "Get Account Authentication Settings", "request": { "name": "Get Account Authentication Settings", "description": { "content": "Use this endpoint to view account authentication settings", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "account-authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d4091482-7fdf-4d69-b9f5-d4e9ff32be75", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "settings", "account-authentication" ], "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" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"enable_self_signup\": true,\n \"auto_create_account_for_account_members\": true,\n \"account_member_self_management\": \"disabled\",\n \"account_management_authentication_token_timeout_secs\": 86400,\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"relationships\": {\n \"authentication_realm\": {\n \"data\": {\n \"id\": \"3418c54e-d768-42c1-a9db-d7afd2a18452\",\n \"type\": \"string\",\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/authentication-realms/3418c54e-d768-42c1-a9db-d7afd2a18452\"\n }\n }\n }\n },\n \"meta\": {\n \"client_id\": \"account-management\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account_authentication_settings\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e1c342b-16cf-4fd5-9cdc-1f7eac7ed7a5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "settings", "account-authentication" ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1c9588a-0e0d-4668-9b4d-a8937bdad29b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "settings", "account-authentication" ], "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 \"errors\": [\n {\n \"title\": \"Unauthorized\",\n \"status\": \"401\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12480480-a308-4173-9857-ed3f2d3c4989", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "settings", "account-authentication" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6cd5ef47-ad82-491d-9596-9cd44a47bfad", "name": "Update Account Authentication Settings", "request": { "name": "Update Account Authentication Settings", "description": { "content": "Use this endpoint to update account authentication settings", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "account-authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"enable_self_signup\": true,\n \"auto_create_account_for_account_members\": true,\n \"account_member_self_management\": \"disabled\",\n \"account_management_authentication_token_timeout_secs\": 86400\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1e905295-6529-4e78-a679-9728b25a9431", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "settings", "account-authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"type\": \"string\",\n \"enable_self_signup\": true,\n \"auto_create_account_for_account_members\": true,\n \"account_member_self_management\": \"disabled\",\n \"account_management_authentication_token_timeout_secs\": 86400\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"enable_self_signup\": true,\n \"auto_create_account_for_account_members\": true,\n \"account_member_self_management\": \"disabled\",\n \"account_management_authentication_token_timeout_secs\": 86400,\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"relationships\": {\n \"authentication_realm\": {\n \"data\": {\n \"id\": \"3418c54e-d768-42c1-a9db-d7afd2a18452\",\n \"type\": \"string\",\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/authentication-realms/3418c54e-d768-42c1-a9db-d7afd2a18452\"\n }\n }\n }\n },\n \"meta\": {\n \"client_id\": \"account-management\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account_authentication_settings\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fe0b90e-844e-4d1b-a25d-3f6ffed66ea3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "settings", "account-authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"type\": \"string\",\n \"enable_self_signup\": true,\n \"auto_create_account_for_account_members\": true,\n \"account_member_self_management\": \"disabled\",\n \"account_management_authentication_token_timeout_secs\": 86400\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d562cd83-aeb1-45d0-bb52-f46d0c3cdde3", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "settings", "account-authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"type\": \"string\",\n \"enable_self_signup\": true,\n \"auto_create_account_for_account_members\": true,\n \"account_member_self_management\": \"disabled\",\n \"account_management_authentication_token_timeout_secs\": 86400\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"store id mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bb838a5-2cfe-43e4-9595-9c49d0cee669", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "settings", "account-authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"type\": \"string\",\n \"enable_self_signup\": true,\n \"auto_create_account_for_account_members\": true,\n \"account_member_self_management\": \"disabled\",\n \"account_management_authentication_token_timeout_secs\": 86400\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account Tags", "description": "Account Tags are custom labels or metadata that can be attached to accounts to help organize and filter them based on specific attributes or criteria.\n", "item": [ { "id": "63b0f5a8-a310-49e3-b677-af6cc2946ce6", "name": "Create an Account Tag", "request": { "name": "Create an Account Tag", "description": { "content": "Create an Account Tag", "type": "text/plain" }, "url": { "path": [ "v2", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_tag\",\n \"name\": \"Account Name\",\n \"description\": \"Account Description\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a766def1-1ee2-4eef-9d7d-399502f4a0a1", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_tag\",\n \"name\": \"Account Name\",\n \"description\": \"Account Description\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"account-name-tag\",\n \"description\": \"string\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account-tags/deb6b25f-8451-4211-9a22-95610333df23\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5258a99-ef57-4f0e-bacf-ac29414928d5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_tag\",\n \"name\": \"Account Name\",\n \"description\": \"Account Description\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76789b38-9d9f-48e5-a1b0-99336962a948", "name": "Conflict", "originalRequest": { "url": { "path": [ "v2", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_tag\",\n \"name\": \"Account Name\",\n \"description\": \"Account Description\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"account membership with the given account id and account member id already exists\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26746012-065e-4c39-bf26-4cd5c15db608", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_tag\",\n \"name\": \"Account Name\",\n \"description\": \"Account Description\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a27aa597-760c-484f-96c6-d87230c2ad48", "name": "List Account Tags", "request": { "name": "List Account Tags", "description": { "content": "Retrieves a list of Account Tags\n\n## Filtering\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) Account Tags:\n\n| Attribute | Operators | Example |\n|------------------|-------------------------------|-----------------------------------------------|\n| `id` | `lt`,`le`,`eq`,`gt`,`ge`,`in` | `eq(id,3fa85f64-5717-4562-b3fc-2c963f66afa6)` |\n| `created_at` | `lt`,`le`,`eq`,`gt`,`ge` | `ge(created_at,2024-04-29T00:00:00.000Z)` |\n| `updated_at` | `lt`,`le`,`eq`,`gt`,`ge` | `le(updated_at,2024-04-29T00:00:00.000Z)` |\n| `name` | `eq`,`like` | `eq(name,AccountName)` |\n\n## Sorting\nThe following attributes are available for sorting. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with `-`, for example, `-updated_at`. The default sort order is `created_at` in descending order.\n- `id`\n- `created_at`\n- `updated_at`\n- `name`\n", "type": "text/plain" }, "url": { "path": [ "v2", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the order in which account tags will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "37ba3efc-c8bf-4377-a0a6-7242abe94d61", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the order in which account tags will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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 \"type\": \"string\",\n \"name\": \"account-name-tag\",\n \"description\": \"string\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account-tags/deb6b25f-8451-4211-9a22-95610333df23\"\n }\n },\n {\n \"type\": \"string\",\n \"name\": \"account-name-tag\",\n \"description\": \"string\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account-tags/deb6b25f-8451-4211-9a22-95610333df23\"\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"limit\": 25,\n \"current\": 0,\n \"offset\": 0,\n \"total\": 1\n },\n \"results\": {\n \"total\": 1\n }\n },\n \"links\": {\n \"current\": \"https://KBXc.oeUDQYaRU-\",\n \"first\": \"https://lDAEorcYJeTogEyrAAFDaIhgGSIyrPyc.fqalO2yYd2vdpQ\",\n \"last\": \"https://vWvwbStwYFjahPlJWpdG.osxkIl20Eu6Bw.he\",\n \"next\": \"string\",\n \"prev\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ad94692-81c5-45d8-b94b-bf640f61d7fc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the order in which account tags will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed9a30d7-bd75-4c7c-a54f-7716b8c0d0d4", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "account-tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "ilike(name,\"*swan*\")" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "Specifies the order in which account tags will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31248f03-c31e-473f-ba6b-a30076ed039b", "name": "Get an Account Tag", "request": { "name": "Get an Account Tag", "description": { "content": "Get an Account Tag", "type": "text/plain" }, "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id", "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "83dc4c7e-b913-455b-b7d5-942576797474", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id" } ] }, "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 \"type\": \"string\",\n \"name\": \"account-name-tag\",\n \"description\": \"string\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account-tags/deb6b25f-8451-4211-9a22-95610333df23\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e71d741-9084-4a28-9030-cb2643cd58b2", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "324d59bd-b05c-4941-a980-4ac39a03b445", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7dce342a-a9ae-493b-a767-043da9c96b7c", "name": "Update an Account Tag", "request": { "name": "Update an Account Tag", "description": { "content": "Update an Account Tag", "type": "text/plain" }, "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id", "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"account_tag\",\n \"name\": \"Account Name\",\n \"description\": \"Account Description\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "96395f60-7344-4e38-87fb-e23e2e696202", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id" } ] }, "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 \"data\": {\n \"type\": \"account_tag\",\n \"name\": \"Account Name\",\n \"description\": \"Account Description\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"account-name-tag\",\n \"description\": \"string\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/account-tags/deb6b25f-8451-4211-9a22-95610333df23\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab1182e1-834e-4e7a-b2c3-58c60446f31a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id" } ] }, "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 \"data\": {\n \"type\": \"account_tag\",\n \"name\": \"Account Name\",\n \"description\": \"Account Description\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baa39c08-d08c-4cc8-97ef-2385a01e7205", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id" } ] }, "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 \"data\": {\n \"type\": \"account_tag\",\n \"name\": \"Account Name\",\n \"description\": \"Account Description\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f82991ba-82a9-432c-a675-e98c433f0b34", "name": "Conflict", "originalRequest": { "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id" } ] }, "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 \"data\": {\n \"type\": \"account_tag\",\n \"name\": \"Account Name\",\n \"description\": \"Account Description\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"account membership with the given account id and account member id already exists\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "955ff1c7-e4bc-4186-b478-c47f147a143c", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id" } ] }, "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 \"data\": {\n \"type\": \"account_tag\",\n \"name\": \"Account Name\",\n \"description\": \"Account Description\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1961dfc4-c421-4504-813c-445ff4b8c770", "name": "Delete an Account Tag", "request": { "name": "Delete an Account Tag", "description": { "content": "Delete an Account Tag", "type": "text/plain" }, "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id", "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "8e9e8601-23d6-426b-88af-147ef4872150", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id" } ] }, "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": "4649f0d1-f3c1-4e2c-af0f-029b875f2b08", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cfbd428-8e3d-44e2-90d9-47ed847e085f", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "account-tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Account Tag.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "tag_id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account Addresses", "description": "The API to organize account addresses.", "item": [ { "id": "21ceb83a-b595-4b8f-aab3-67a3fd502a85", "name": "Create an Account Address", "request": { "name": "Create an Account Address", "description": { "content": "Create an address for an Account.", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "accountID", "disabled": false, "description": { "content": "(Required) The ID of the account you want to create an address for.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "214b82e5-0a01-4b49-b846-dfced055ed22", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\",\n \"id\": \"5f8da740-6680-463e-b31c-190b2db4bf9d\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses\"\n },\n \"relationships\": {\n \"account\": {\n \"id\": \"11afcf9b-971b-4fdb-8e10-f2ecf970718e\",\n \"type\": \"account\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed8c9315-b4c3-4493-8b40-0bc1bddbd5a1", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\",\n \"id\": \"5f8da740-6680-463e-b31c-190b2db4bf9d\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses\"\n },\n \"relationships\": {\n \"account\": {\n \"id\": \"11afcf9b-971b-4fdb-8e10-f2ecf970718e\",\n \"type\": \"account\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ebae4c3-40b4-46a1-9900-c3a693b6f15d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Bad Request\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c4ce588-e634-4ebc-8e20-525e29d89521", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86560311-63bd-4f32-8a52-680ac8a44339", "name": "Get Account Addresses", "request": { "name": "Get Account Addresses", "description": { "content": "Get all addresses for an Account.\n\nYou can use pagination with this resource. For more information, see [pagination](/guides/Getting-Started/pagination).\n\n### Filtering\n\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) addresses:\n\n| Attribute | Operators | Example |\n|----------------|---------------------------------|---------------------------------------|\n| `name` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(name,\"*home*\")` |\n| `first_name` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(first_name,\"Ron*\")` |\n| `last_name` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(last_name,\"*swan*\")` |\n| `phone_number` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(phone_number,\"*555*\")` |\n| `company_name` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(company_name,\"*enterprises*\")` |\n| `instructions` | `eq`,`in`,`like`,`ilike`,`text` | `text(instructions,\"behind bin\")` |\n| `line_1` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(line_1,\"*Sunny Street*\")` |\n| `line_2` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(line_2,\"*Unit*\")` |\n| `city` | `eq`,`in`,`like`,`ilike`,`text` | `eq(city,\"Sunny Town\")` |\n| `county` | `eq`,`in`,`like`,`ilike`,`text` | `eq(county,\"Sunnyville\")` |\n| `region` | `eq`,`in`,`like`,`ilike`,`text` | `eq(region,\"California\")` |\n| `postcode` | `eq`,`in`,`like`,`ilike`,`text` | `eq(postcode,\"SU33 1YY\")` |\n| `country` | `eq`,`in`,`like`,`ilike`,`text` | `eq(country,\"GB\")` |\n", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. If not specified, defaults to the `page_length` setting from the Settings API.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The method used to calculate the total count. `lower_bound` limits expensive count operations, `observed` uses a lightweight +1 fetch strategy that will indicate if there is a next page. (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter addresses using a simple query language.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "accountID", "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "97ce3d68-0421-48c6-bf35-c0ab0d56d062", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. If not specified, defaults to the `page_length` setting from the Settings API.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The method used to calculate the total count. `lower_bound` limits expensive count operations, `observed` uses a lightweight +1 fetch strategy that will indicate if there is a next page. (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter addresses using a simple query language.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" } ] }, "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 \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\",\n \"id\": \"5f8da740-6680-463e-b31c-190b2db4bf9d\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses\"\n },\n \"relationships\": {\n \"account\": {\n \"id\": \"11afcf9b-971b-4fdb-8e10-f2ecf970718e\",\n \"type\": \"account\"\n }\n }\n },\n {\n \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\",\n \"id\": \"5f8da740-6680-463e-b31c-190b2db4bf9d\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses\"\n },\n \"relationships\": {\n \"account\": {\n \"id\": \"11afcf9b-971b-4fdb-8e10-f2ecf970718e\",\n \"type\": \"account\"\n }\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"limit\": 25,\n \"offset\": 0,\n \"current\": 1,\n \"total\": 3\n },\n \"results\": {\n \"total\": 75,\n \"total_method\": \"exact\"\n }\n },\n \"links\": {\n \"current\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses?page[offset]=0&page[limit]=25\",\n \"first\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses?page[offset]=0&page[limit]=25\",\n \"last\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses?page[offset]=50&page[limit]=25\",\n \"next\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses?page[offset]=25&page[limit]=25\",\n \"prev\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f305877-69ef-4922-a680-3e5e99e7cc6d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. If not specified, defaults to the `page_length` setting from the Settings API.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The method used to calculate the total count. `lower_bound` limits expensive count operations, `observed` uses a lightweight +1 fetch strategy that will indicate if there is a next page. (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter addresses using a simple query language.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Bad Request\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a08b2ae2-e3fb-4cb4-ab78-1bc719803c09", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. If not specified, defaults to the `page_length` setting from the Settings API.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The method used to calculate the total count. `lower_bound` limits expensive count operations, `observed` uses a lightweight +1 fetch strategy that will indicate if there is a next page. (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter addresses using a simple query language.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" } ] }, "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 \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6886602b-68b0-4196-bc53-c29b89432507", "name": "Get an Account Address", "request": { "name": "Get an Account Address", "description": { "content": "Get a specific address for an Account.", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "accountID", "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "addressID", "disabled": false, "description": { "content": "(Required) The ID of the address you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4926b284-705f-4c0e-a385-5653484fcb4c", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The ID of the address you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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 \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\",\n \"id\": \"5f8da740-6680-463e-b31c-190b2db4bf9d\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses\"\n },\n \"relationships\": {\n \"account\": {\n \"id\": \"11afcf9b-971b-4fdb-8e10-f2ecf970718e\",\n \"type\": \"account\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bc2eb76-53cf-42d2-b6c8-7e592fbb6f07", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The ID of the address you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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 \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8200ee7e-ae45-4e36-90df-bd654cb26a26", "name": "Update an Account Address", "request": { "name": "Update an Account Address", "description": { "content": "Update an address for an Account.", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "accountID", "disabled": false, "description": { "content": "(Required) The ID of the account you want to create an address for.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "addressID", "disabled": false, "description": { "content": "(Required) The ID of the address you want to update.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "75ef9460-ffe7-4902-a5da-d3047dddce0c", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The ID of the address you want to update.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\",\n \"id\": \"5f8da740-6680-463e-b31c-190b2db4bf9d\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses\"\n },\n \"relationships\": {\n \"account\": {\n \"id\": \"11afcf9b-971b-4fdb-8e10-f2ecf970718e\",\n \"type\": \"account\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4209afa3-bbc8-4be3-aa79-7f1e1e14f23a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The ID of the address you want to update.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Bad Request\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d99dd583-5e44-47fe-b2fe-c97fe09300d8", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The ID of the address you want to update.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5683ecab-f8ea-4a2b-bb24-45ae4f8b3a65", "name": "Delete an Account Address", "request": { "name": "Delete an Account Address", "description": { "content": "Delete an address for an Account.", "type": "text/plain" }, "url": { "path": [ "v2", "accounts", ":accountID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "accountID", "disabled": false, "description": { "content": "(Required) The ID of the account that contains the address to delete.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "addressID", "disabled": false, "description": { "content": "(Required) The ID of the address to delete.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fce5d581-e43f-48b4-8ceb-f04817b0516a", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account that contains the address to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The ID of the address to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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": "fa120164-a6b0-4da3-8222-d69b935a4b6d", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "accounts", ":accountID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the account that contains the address to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) The ID of the address to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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 \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"account not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Generate an Access Token", "description": "", "item": [ { "id": "cbe800fe-4c4f-4767-b38a-2174335483e8", "name": "Create an Access Token", "request": { "name": "Create an Access Token", "description": { "content": "\n### Client Credentials\n\nA `client_credentials` token is used when the credentials are not publicly exposed, usually a server-side language such as PHP or Node.js. This type of authentication enables `CRUD` access to all resources.\n\n`client_id` and `client_secret` are created and managed via [Application Keys](/docs/api/application-keys/create-an-application-key).\n\nTo see the access granted by a `client_credentials` token, refer to [Permissions](/docs/authentication/tokens/permissions).\n\n\n### Implicit\n\nAn `implicit` token is typically used for situations where you are requesting data on the client side and you are exposing your public key. When authenticated implicitly, you can only fetch (`GET`) data with live status (products, categories, brands, etc).\n\nThe `implicit` token is most appropriate for use inside client-side applications, such as JavaScript.\n\n:::caution\nAn `implicit` token can be thought of as a **Read only** token.\n:::\n", "type": "text/plain" }, "url": { "path": [ "oauth", "access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) The grant type.", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "(Required) Your `client_id`", "type": "text/plain" }, "key": "client_id", "value": "string" }, { "disabled": false, "description": { "content": "Your `client_secret`. Only required for client credentials.", "type": "text/plain" }, "key": "client_secret", "value": "string" } ] }, "auth": null }, "response": [ { "id": "a76c6cc8-00e3-4630-b9d8-1450cb380613", "name": "Access Token", "originalRequest": { "url": { "path": [ "oauth", "access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) The grant type.", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "(Required) Your `client_id`", "type": "text/plain" }, "key": "client_id", "value": "string" }, { "disabled": false, "description": { "content": "Your `client_secret`. Only required for client credentials.", "type": "text/plain" }, "key": "client_secret", "value": "string" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"xa3521ca621113e44eeed9232fa3e54571cb08bc\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600,\n \"expires\": 1524486008,\n \"identifier\": \"client_credentials\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed67de64-7d59-46b5-9578-ea5f85a3b30c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "oauth", "access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) The grant type.", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "(Required) Your `client_id`", "type": "text/plain" }, "key": "client_id", "value": "string" }, { "disabled": false, "description": { "content": "Your `client_secret`. Only required for client credentials.", "type": "text/plain" }, "key": "client_secret", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a42daff1-a35c-4e35-a656-25de591cd80f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "oauth", "access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) The grant type.", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "(Required) Your `client_id`", "type": "text/plain" }, "key": "client_id", "value": "string" }, { "disabled": false, "description": { "content": "Your `client_secret`. Only required for client credentials.", "type": "text/plain" }, "key": "client_secret", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Unauthorized\",\n \"status\": \"401\",\n \"detail\": \"Unauthorized\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "978fdf2a-56bb-4379-9939-8087f674ce80", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "oauth", "access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) The grant type.", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "(Required) Your `client_id`", "type": "text/plain" }, "key": "client_id", "value": "string" }, { "disabled": false, "description": { "content": "Your `client_secret`. Only required for client credentials.", "type": "text/plain" }, "key": "client_secret", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Customer Addresses", "description": "The API to organize customer addresses.", "item": [ { "id": "ae8a56fe-ca5c-483b-b5e9-e59122accf9d", "name": "Create a Customer Address", "request": { "name": "Create a Customer Address", "description": { "content": "Create an address for a Customer.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "customerID", "disabled": false, "description": { "content": "(Required) The ID of the customer you want to create an address for.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a72b4572-888c-45ef-ba5a-e572bdebb4e0", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\",\n \"id\": \"5f8da740-6680-463e-b31c-190b2db4bf9d\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/customers/deb6b25f-8451-4211-9a22-95610333df23/addresses\"\n },\n \"relationships\": {\n \"customer\": {\n \"id\": \"11afcf9b-971b-4fdb-8e10-f2ecf970718e\",\n \"type\": \"customer\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a758b58-77d8-47cd-b20c-b05ae6d6e23d", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\",\n \"id\": \"5f8da740-6680-463e-b31c-190b2db4bf9d\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/customers/deb6b25f-8451-4211-9a22-95610333df23/addresses\"\n },\n \"relationships\": {\n \"customer\": {\n \"id\": \"11afcf9b-971b-4fdb-8e10-f2ecf970718e\",\n \"type\": \"customer\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6e4bbc6-d589-4dcf-875b-73f60fc4f7f3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Bad Request\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "045ddaa9-2e9d-4362-9c71-3ec67cbf38d2", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"customer not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c5436396-3d23-4715-a66b-6c3309dbacdc", "name": "Get Customer Addresses", "request": { "name": "Get Customer Addresses", "description": { "content": "Get all addresses for a Customer.\n\nYou can use pagination with this resource. For more information, see [pagination](/guides/Getting-Started/pagination).\n\n### Filtering\n\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) addresses:\n\n| Attribute | Operators | Example |\n|----------------|---------------------------------|---------------------------------------|\n| `name` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(name,\"*home*\")` |\n| `first_name` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(first_name,\"Ron*\")` |\n| `last_name` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(last_name,\"*swan*\")` |\n| `phone_number` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(phone_number,\"*555*\")` |\n| `company_name` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(company_name,\"*enterprises*\")` |\n| `instructions` | `eq`,`in`,`like`,`ilike`,`text` | `text(instructions,\"behind bin\")` |\n| `line_1` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(line_1,\"*Sunny Street*\")` |\n| `line_2` | `eq`,`in`,`like`,`ilike`,`text` | `ilike(line_2,\"*Unit*\")` |\n| `city` | `eq`,`in`,`like`,`ilike`,`text` | `eq(city,\"Sunny Town\")` |\n| `county` | `eq`,`in`,`like`,`ilike`,`text` | `eq(county,\"Sunnyville\")` |\n| `region` | `eq`,`in`,`like`,`ilike`,`text` | `eq(region,\"California\")` |\n| `postcode` | `eq`,`in`,`like`,`ilike`,`text` | `eq(postcode,\"SU33 1YY\")` |\n| `country` | `eq`,`in`,`like`,`ilike`,`text` | `eq(country,\"GB\")` |\n", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. If not specified, defaults to the `page_length` setting from the Settings API.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The method used to calculate the total count. `lower_bound` limits expensive count operations, `observed` uses a lightweight +1 fetch strategy that will indicate if there is a next page. (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter addresses using a simple query language.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "customerID", "disabled": false, "description": { "content": "(Required) The ID of the customer you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e721b038-ece8-45a3-955c-0a317b0e2562", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. If not specified, defaults to the `page_length` setting from the Settings API.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The method used to calculate the total count. `lower_bound` limits expensive count operations, `observed` uses a lightweight +1 fetch strategy that will indicate if there is a next page. (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter addresses using a simple query language.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" } ] }, "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 \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\",\n \"id\": \"5f8da740-6680-463e-b31c-190b2db4bf9d\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/customers/deb6b25f-8451-4211-9a22-95610333df23/addresses\"\n },\n \"relationships\": {\n \"customer\": {\n \"id\": \"11afcf9b-971b-4fdb-8e10-f2ecf970718e\",\n \"type\": \"customer\"\n }\n }\n },\n {\n \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\",\n \"id\": \"5f8da740-6680-463e-b31c-190b2db4bf9d\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/customers/deb6b25f-8451-4211-9a22-95610333df23/addresses\"\n },\n \"relationships\": {\n \"customer\": {\n \"id\": \"11afcf9b-971b-4fdb-8e10-f2ecf970718e\",\n \"type\": \"customer\"\n }\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"limit\": 25,\n \"offset\": 0,\n \"current\": 1,\n \"total\": 3\n },\n \"results\": {\n \"total\": 75,\n \"total_method\": \"exact\"\n }\n },\n \"links\": {\n \"current\": \"https://useast.api.elasticpath.com/v2/customers/deb6b25f-8451-4211-9a22-95610333df23/addresses?page[offset]=0&page[limit]=25\",\n \"first\": \"https://useast.api.elasticpath.com/v2/customers/deb6b25f-8451-4211-9a22-95610333df23/addresses?page[offset]=0&page[limit]=25\",\n \"last\": \"https://useast.api.elasticpath.com/v2/customers/deb6b25f-8451-4211-9a22-95610333df23/addresses?page[offset]=50&page[limit]=25\",\n \"next\": \"https://useast.api.elasticpath.com/v2/customers/deb6b25f-8451-4211-9a22-95610333df23/addresses?page[offset]=25&page[limit]=25\",\n \"prev\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "803dd459-c81c-4a82-ae63-e3ab46e2784a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. If not specified, defaults to the `page_length` setting from the Settings API.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The method used to calculate the total count. `lower_bound` limits expensive count operations, `observed` uses a lightweight +1 fetch strategy that will indicate if there is a next page. (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter addresses using a simple query language.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Bad Request\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "178a1e26-e582-42ba-a6ab-92d9b9ea711f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. If not specified, defaults to the `page_length` setting from the Settings API.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The method used to calculate the total count. `lower_bound` limits expensive count operations, `observed` uses a lightweight +1 fetch strategy that will indicate if there is a next page. (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter addresses using a simple query language.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" } ] }, "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 \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"customer not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "27f7d88b-095b-4eb5-9abb-7d51c557898b", "name": "Get an Customer Address", "request": { "name": "Get an Customer Address", "description": { "content": "Get an address for a Customer.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "customerID", "disabled": false, "description": { "content": "(Required) The ID of the customer you want to retrieve.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "addressID", "disabled": false, "description": { "content": "(Required) The ID of the address you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4b7f5076-4158-4971-8efa-75413a85a3ac", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" }, { "disabled": false, "description": { "content": "(Required) The ID of the address you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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 \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\",\n \"id\": \"5f8da740-6680-463e-b31c-190b2db4bf9d\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/customers/deb6b25f-8451-4211-9a22-95610333df23/addresses\"\n },\n \"relationships\": {\n \"customer\": {\n \"id\": \"11afcf9b-971b-4fdb-8e10-f2ecf970718e\",\n \"type\": \"customer\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70f0e590-5853-4136-ae75-58014225b7f0", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" }, { "disabled": false, "description": { "content": "(Required) The ID of the address you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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 \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"customer not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "901d17aa-336c-4ae5-87b8-7a2c2b9f033a", "name": "Update an Customer Address", "request": { "name": "Update an Customer Address", "description": { "content": "Update an address for a Customer.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "customerID", "disabled": false, "description": { "content": "(Required) The ID of the customer you want to create an address for.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "addressID", "disabled": false, "description": { "content": "(Required) The ID of the customer you want to update.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a05a56cd-6099-443e-8cfc-782302d7431e", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" }, { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to update.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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 \"data\": {\n \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\",\n \"id\": \"5f8da740-6680-463e-b31c-190b2db4bf9d\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/customers/deb6b25f-8451-4211-9a22-95610333df23/addresses\"\n },\n \"relationships\": {\n \"customer\": {\n \"id\": \"11afcf9b-971b-4fdb-8e10-f2ecf970718e\",\n \"type\": \"customer\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "047dedf6-dcc6-4bef-9be2-7962afd12570", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" }, { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to update.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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 \"data\": {\n \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Bad Request\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e40ea73-5c11-4212-ab6c-b562ba2d595c", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to create an address for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" }, { "disabled": false, "description": { "content": "(Required) The ID of the customer you want to update.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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 \"data\": {\n \"type\": \"address\",\n \"first_name\": \"Ron\",\n \"last_name\": \"Swanson\",\n \"name\": \"Home\",\n \"phone_number\": \"(555) 555-1234\",\n \"instructions\": \"Leave behind bin\",\n \"company_name\": \"Ron Swanson Enterprises\",\n \"line_1\": \"1 Sunny Street\",\n \"line_2\": \"Unit 101\",\n \"city\": \"Sunny Town\",\n \"county\": \"Sunnyville\",\n \"region\": \"acc-legal-name\",\n \"postcode\": \"SU33 1YY\",\n \"country\": \"GB\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"customer not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae646e90-8c82-4ff6-bbbd-760483d0de94", "name": "Delete a Customer Address", "request": { "name": "Delete a Customer Address", "description": { "content": "Delete an address for a Customer.", "type": "text/plain" }, "url": { "path": [ "v2", "customers", ":customerID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "customerID", "disabled": false, "description": { "content": "(Required) The ID of the customer that contains the address to delete.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "addressID", "disabled": false, "description": { "content": "(Required) The ID of the address to delete.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "aafc5db7-f1e4-4b4f-aa72-2f3a0dfcb5f1", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer that contains the address to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" }, { "disabled": false, "description": { "content": "(Required) The ID of the address to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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": "b9cb9a0c-aefc-436a-8a28-36ac709fb492", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "customers", ":customerID", "addresses", ":addressID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the customer that contains the address to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customerID" }, { "disabled": false, "description": { "content": "(Required) The ID of the address to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "addressID" } ] }, "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 \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"customer not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Application Keys", "description": "You can use application keys to generate `client_credentials` and `implicit` tokens.", "item": [ { "id": "65e26171-9171-48bf-aeeb-7d47dc41c6a1", "name": "Create an Application Key", "request": { "name": "Create an Application Key", "description": { "content": "Create an Application Key", "type": "text/plain" }, "url": { "path": [ "v2", "application-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"application_key\",\n \"name\": \"Storefront-Key\",\n \"reserved_rate_limit\": 0\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f4d14ca3-fa30-46d5-ba29-52e4653dad2f", "name": "An Application Key", "originalRequest": { "url": { "path": [ "v2", "application-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"application_key\",\n \"name\": \"Storefront-Key\",\n \"reserved_rate_limit\": 0\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"cc0ee077-8a02-c9a3-5203-4a8567b7224b\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"reserved_rate_limit\": 3830,\n \"client_id\": \"Z2dDp1f1Tg30p2C6ZVit7W1AKUtVhMVSTAPOIK4adA\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\",\n \"last_used_at\": \"2017-01-10T11:41:19.244Z\"\n }\n },\n \"client_secret\": \"jN8qLHneOn8C1rv0r3J3XZK1cRiZG3rajcLi9X1cZZ\"\n },\n \"links\": {\n \"self\": \"http://hGyDuIkiSsKBshmYOcB.jtF8LuC9l8HzMNcCyYoOmyWKDpMFTgk\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67e94cf7-12a1-45e0-ba5e-a1c8a2c66560", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "application-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"application_key\",\n \"name\": \"Storefront-Key\",\n \"reserved_rate_limit\": 0\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d85ec85d-7c7e-4aa4-b831-d7fe2c5348de", "name": "Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "application-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"application_key\",\n \"name\": \"Storefront-Key\",\n \"reserved_rate_limit\": 0\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"Requested reserved rate limit will exceed the maximum.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb0a671a-839f-45b6-9e7e-0ddc6e5555d7", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "application-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"application_key\",\n \"name\": \"Storefront-Key\",\n \"reserved_rate_limit\": 0\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "997d9d51-4cbe-4855-ac97-807411264928", "name": "List Application Keys", "request": { "name": "List Application Keys", "description": { "content": "Retrieves a list of Application Keys\n", "type": "text/plain" }, "url": { "path": [ "v2", "application-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "73d88f0e-663a-4739-87a2-09433eeff212", "name": "List of Application Keys", "originalRequest": { "url": { "path": [ "v2", "application-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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\": \"d2e6275c-0604-75db-5e99-68e3f4e30234\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"reserved_rate_limit\": 8623,\n \"client_id\": \"Z2dDp1f1Tg30p2C6ZVit7W1AKUtVhMVSTAPOIK4adA\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\",\n \"last_used_at\": \"2017-01-10T11:41:19.244Z\"\n }\n }\n },\n {\n \"id\": \"25c91844-8005-1339-daf5-86ab2ba4d0cf\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"reserved_rate_limit\": 2167,\n \"client_id\": \"Z2dDp1f1Tg30p2C6ZVit7W1AKUtVhMVSTAPOIK4adA\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\",\n \"last_used_at\": \"2017-01-10T11:41:19.244Z\"\n }\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 872\n },\n \"page\": {\n \"limit\": 100,\n \"offset\": 0,\n \"current\": 1,\n \"total\": 1\n },\n \"total_reserved_rate_limit\": 100\n },\n \"links\": {\n \"current\": null,\n \"first\": null,\n \"last\": null,\n \"next\": null,\n \"prev\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfbf2058-c046-4f3f-8c48-52bc8e172b00", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "application-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b069ddb-dff6-40ce-b4d7-1def37a17e98", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "application-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3267bcd6-12ac-4b28-b20a-12f0704d03e6", "name": "Get an Application Key", "request": { "name": "Get an Application Key", "description": { "content": "Get an Application Key", "type": "text/plain" }, "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8b9423d5-6f04-4261-8f39-552c9a41f4ae", "name": "An Application Key", "originalRequest": { "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id" } ] }, "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 \"id\": \"c0756395-d7af-639c-5c66-783d302edfdc\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"reserved_rate_limit\": 6340,\n \"client_id\": \"Z2dDp1f1Tg30p2C6ZVit7W1AKUtVhMVSTAPOIK4adA\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\",\n \"last_used_at\": \"2017-01-10T11:41:19.244Z\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://UzodifI.whZjT-ujtmAmTlDhSpAyzK\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33af7255-41e4-4b3a-afa1-ebedfafc2f22", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "775df9de-6adc-48e3-a8f7-936ad28a1781", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81091222-9d0e-4618-8729-36899bc9a697", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44905971-9988-401b-bfbb-a0d6019180c1", "name": "Update an Application Key", "request": { "name": "Update an Application Key", "description": { "content": "Update an Application Key", "type": "text/plain" }, "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"application_key\",\n \"name\": \"Batch-Processing\",\n \"reserved_rate_limit\": 10\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "be44b0d0-4387-4f6e-a084-dc433ffa6d1d", "name": "An Application Key", "originalRequest": { "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id" } ] }, "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 \"data\": {\n \"type\": \"application_key\",\n \"name\": \"Batch-Processing\",\n \"reserved_rate_limit\": 10\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"c0756395-d7af-639c-5c66-783d302edfdc\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"reserved_rate_limit\": 6340,\n \"client_id\": \"Z2dDp1f1Tg30p2C6ZVit7W1AKUtVhMVSTAPOIK4adA\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\",\n \"last_used_at\": \"2017-01-10T11:41:19.244Z\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://UzodifI.whZjT-ujtmAmTlDhSpAyzK\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d859f38-48e9-4404-ac79-b8050d34e02b", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id" } ] }, "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 \"data\": {\n \"type\": \"application_key\",\n \"name\": \"Batch-Processing\",\n \"reserved_rate_limit\": 10\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "046fccbf-1fdb-47a9-9531-e9be6d618d53", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id" } ] }, "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 \"data\": {\n \"type\": \"application_key\",\n \"name\": \"Batch-Processing\",\n \"reserved_rate_limit\": 10\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2946589c-7b31-423d-b684-a4e5d0cef5ef", "name": "Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id" } ] }, "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 \"data\": {\n \"type\": \"application_key\",\n \"name\": \"Batch-Processing\",\n \"reserved_rate_limit\": 10\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"Requested reserved rate limit will exceed the maximum.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac9f1448-2e9c-4a2d-bc34-ecdc6adc2529", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id" } ] }, "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 \"data\": {\n \"type\": \"application_key\",\n \"name\": \"Batch-Processing\",\n \"reserved_rate_limit\": 10\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2c5a5217-880c-4614-85bf-479e1ddececa", "name": "Delete an Application Key", "request": { "name": "Delete an Application Key", "description": { "content": "Delete an Application Key", "type": "text/plain" }, "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "4f92a4e5-4530-477a-a8ff-fd23fb94d979", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id" } ] }, "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": "9980a465-146b-4f6f-b2b5-256c0f31c1e2", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3929ee89-1492-4b7a-b791-b11cb7c71463", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ff25636-c630-4733-bb96-1ad8029edb81", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "application-keys", ":application-key-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Application Key.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "application-key-id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "769495da-af65-4854-b337-0bb480bd9029", "name": "Get the Merchant Realm Mapping for the current store", "request": { "name": "Get the Merchant Realm Mapping for the current store", "description": { "content": "This API is used to obtain an [Authentication Realm](/docs/api/single-sign-on/authentication-realms) if there is none yet for the current store.\n", "type": "text/plain" }, "url": { "path": [ "v2", "merchant-realm-mappings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "37e07dac-ef10-4866-9b07-2df9c79db596", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "merchant-realm-mappings" ], "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" } ], "body": "{\n \"data\": {\n \"id\": \"0c45e4ec-26e0-4043-86e4-c15b9cf985a0\",\n \"prefix\": \"myCompany\",\n \"type\": \"string\",\n \"realm_id\": \"e730bf37-ed95-4ca9-b4c4-2c5ee08b21d7\",\n \"store_id\": \"88888888-4444-4333-8333-111111111111\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b9ff8d5-2627-41ca-8d0f-386b8a0186d4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "merchant-realm-mappings" ], "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 \"errors\": [\n {\n \"title\": \"Unauthorized\",\n \"status\": \"401\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f27a78b-149b-4a51-8134-db8446653f7e", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "merchant-realm-mappings" ], "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8bcf49e9-3985-4471-8cef-bc73f6f890a3", "name": "Get a Merchant Realm Mapping", "request": { "name": "Get a Merchant Realm Mapping", "description": {}, "url": { "path": [ "v2", "merchant-realm-mappings", ":mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0", "key": "mapping_id", "disabled": false, "description": { "content": "(Required) The id of the Application Key.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cd96cbb3-97b4-47a6-a80b-d99efe62368d", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "merchant-realm-mappings", ":mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the Application Key.", "type": "text/plain" }, "type": "any", "value": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0", "key": "mapping_id" } ] }, "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 \"id\": \"0c45e4ec-26e0-4043-86e4-c15b9cf985a0\",\n \"prefix\": \"myCompany\",\n \"type\": \"string\",\n \"realm_id\": \"e730bf37-ed95-4ca9-b4c4-2c5ee08b21d7\",\n \"store_id\": \"88888888-4444-4333-8333-111111111111\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd2c8db1-1b60-44a8-963c-84d37918c691", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "merchant-realm-mappings", ":mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the Application Key.", "type": "text/plain" }, "type": "any", "value": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0", "key": "mapping_id" } ] }, "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 \"errors\": [\n {\n \"detail\": \"merchant realm mapping not found\",\n \"status\": \"404\",\n \"title\": \"Not Found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc717607-32a6-4271-9e1f-5dc738bddee5", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "merchant-realm-mappings", ":mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the Application Key.", "type": "text/plain" }, "type": "any", "value": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0", "key": "mapping_id" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af2fdc4e-65b1-4d27-ac65-84c4f39b6665", "name": "Update a Merchant Realm Mapping", "request": { "name": "Update a Merchant Realm Mapping", "description": {}, "url": { "path": [ "v2", "merchant-realm-mappings", ":mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0", "key": "mapping_id", "disabled": false, "description": { "content": "(Required) The id of the Application Key.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"prefix\": \"myCompany\",\n \"type\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1b5c233c-44c0-4a65-9dbe-36b432416068", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "merchant-realm-mappings", ":mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the Application Key.", "type": "text/plain" }, "type": "any", "value": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0", "key": "mapping_id" } ] }, "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 \"data\": {\n \"prefix\": \"myCompany\",\n \"type\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"0c45e4ec-26e0-4043-86e4-c15b9cf985a0\",\n \"prefix\": \"myCompany\",\n \"type\": \"string\",\n \"realm_id\": \"e730bf37-ed95-4ca9-b4c4-2c5ee08b21d7\",\n \"store_id\": \"88888888-4444-4333-8333-111111111111\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "717b8d76-ad1c-4b40-af2e-eac601675ec5", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "merchant-realm-mappings", ":mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the Application Key.", "type": "text/plain" }, "type": "any", "value": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0", "key": "mapping_id" } ] }, "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 \"data\": {\n \"prefix\": \"myCompany\",\n \"type\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The field 'prefix' is required.\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6798d9a9-8b0b-4cf4-8512-7b9c1946bad5", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "merchant-realm-mappings", ":mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the Application Key.", "type": "text/plain" }, "type": "any", "value": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0", "key": "mapping_id" } ] }, "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 \"data\": {\n \"prefix\": \"myCompany\",\n \"type\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"merchant realm mapping not found\",\n \"status\": \"404\",\n \"title\": \"Not Found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f57f4411-c348-4082-ac48-58ed90cafb73", "name": "Conflict", "originalRequest": { "url": { "path": [ "v2", "merchant-realm-mappings", ":mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the Application Key.", "type": "text/plain" }, "type": "any", "value": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0", "key": "mapping_id" } ] }, "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 \"data\": {\n \"prefix\": \"myCompany\",\n \"type\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"the prefix is already in use\",\n \"status\": \"409\",\n \"title\": \"Conflict\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7768471c-d9c2-43bc-8155-ed7d31d66741", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "merchant-realm-mappings", ":mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the Application Key.", "type": "text/plain" }, "type": "any", "value": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0", "key": "mapping_id" } ] }, "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 \"data\": {\n \"prefix\": \"myCompany\",\n \"type\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Catalogs", "description": "A catalog contains the products available for sale either in your organization or store. A catalog also contains information about how to organize those products for navigation menus and search facets in a shopper experience.\n\nBefore you create a catalog you must define the following resources:\n\n- Hierarchies: hierarchies and nodes to categorize the products. See [**Hierarchies**](/docs/api/pxm/products/hierarchies).\n- Products: product information, associated assets, and links to hierarchy nodes. See [**Products**](/docs/api/pxm/products/products).\n- Price Books: prices for the products associated with the hierarchies. See [**Price Books**](/docs/api/pxm/pricebooks).\n\nA catalog is a combination of hierarchies and a price book.\n\n### Products\n\nCommerce automatically assigns types to the products you create. Product types can be used in catalogs. For example, in your catalog, you can filter on `parent` so that only your parent products are displayed in your storefront.\n\nYou can use product tags to store or assign a key word against a product or service that you sell in your store. The product tag can then be used to describe or label that product. Product tags represent similarities between products who do not share the same attributes. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. Product tags can be used in catalogs. For example, you can categorize your products based on color. Your shoppers can then search your products by color, enabling shoppers to quickly find what they are looking for, increasing the likelihood of a purchase, and boosting conversion rates.\n\n### Hierarchies\n\nThe hierarchies determine which products appear in the catalog, that is, only the products that are associated with the selected hierarchies are included in the catalog. You can also specify the order you want your hierarchies to display in a published catalog. You can order your hierarchies on a catalog-by-catalog basis.\n\n![Hierarchy_sorting](/assets/hierarchy_sorting.png)\n\nFor more information, see [**create a Catalog**](/docs/api/pxm/catalog/create-catalog).\n\n#### Understanding How Products And Nodes Are Associated\n\nYou can use `breadcrumb` metadata to understand how products and nodes are associated. it explains how products are associated with parent nodes and the relationship among the array of nodes. This is useful if you want to improve how your shoppers search within your store.\n\nThe `breadcrumb` information that you get in an endpoint response depends on whether the endpoint is retrieving product or node details.\n\n| Object | Product/Node | Description |\n| --- | --- | --- |\n| `breadcrumb` | Node | A list of nodes that a product is associated with. Up to 10 levels of nodes are displayed, depending on the number of levels of nodes you have. |\n| `bread_crumbs` | Product | The relationship among the array of nodes a product is associated with, demonstrating the linking of the children nodes with the parent nodes. Up to 10 levels of nodes are displayed, depending on the number of levels of nodes you have. |\n| `bread_crumb_nodes` | Product | An array of parent node IDs that a product is associated with. The `bread_crumb_node` metadata lists up to 10 levels of parent nodes, depending on the number of levels of parent nodes you have. |\n\n#### Understanding `bread_crumbs` Metadata\n\nThe following diagram illustrates a parent and child nodes.\n\n![Breadcrumbs](/assets/breadcrumbs.PNG)\n\n1. The product is in **Node 2**. The ID for **Node 2** is shown first in the first set of breadcrumbs.\n1. **Node 2** is part of **Hierarchy 1**. The ID for **Hierarchy 1** is shown second.\n1. **Node 1** is the parent node of **Node 2**. The ID for **Node 1** is shown last.\n1. The product is also in **Node 3**. The ID for **Node 3** is shown first in the second set of breadcrumbs.\n1. **Node 3** is in the root of **Hierarchy 1**. The ID for **Hierarchy 1** is shown last.\n\nIn the `bread_crumb_nodes` metadata, you can see a list of parent nodes a product is associated with.\n\nIf you subsequently add a product to a new node, then the `bread_crumb_nodes` metadata appends the new node to the top of the list. Using the example above, if we add the product to **Node 1**:\n\n1. The `bread_crumb_nodes` metadata is generated to show the new node appended to the top of the list.\n1. The `bread_crumbs` metadata is updated with the new node.\n\n#### Understanding Breadcrumb Metadata for Child Products\n\nWhen a catalog is published, the breadcrumb information for a child product includes the metadata mentioned for the parent product, in addition to the information specific to the child product. For example, **Product A** is the parent product, associated with **Node 1** and **Node 2**. The metadata for child **Product B** includes **Node 1** and **Node 2**, in addition to its own metadata information.\n\n### Nodes\n\nThe nodes determine which products appear under this in the catalog, that is, only the products that are associated with the selected node are shown under this node.\n\n### Price books\n\nA price book contains the prices for each of the products in the catalog. You can create multiple price books for different scenarios, such as seasonal sales, business versus retail customer pricing, and reward programs. When creating a catalog, you can specify up to five price books. You must set a priority for your price books. Product prices are displayed in the catalog according to the priority of the price books. See [Create a catalog](/docs/api/pxm/catalog/create-catalog).\n", "item": [ { "id": "e3a1d37b-cde0-4aaf-978e-c3e3694570f7", "name": "Creates a new catalog", "request": { "name": "Creates a new catalog", "description": { "content": "Before you create a catalog, you must define the following resources:\n\n- Hierarchies - hierarchies and nodes to categorize the products.\n- Products - product information, associated assets, and links to hierarchy nodes.\n- Price Books - prices for the products associated with the hierarchies. You can create multiple price books for different scenarios, such as seasonal sales, business versus retail customer pricing, and reward programs. When creating a catalog, you can specify up to five price books. You must configure a priority for your price books. Product prices are displayed in the catalog according to the priority of the price books. Priority is a number and the price book with the highest number has the highest priority.\n", "type": "text/plain" }, "url": { "path": [ "catalogs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog\",\n \"attributes\": {\n \"name\": \"catalog-123\",\n \"hierarchy_ids\": [\n \"string\",\n \"string\"\n ],\n \"description\": \"Catalog for Store 123\",\n \"pricebook_id\": \"string\",\n \"pricebook_ids\": [\n {\n \"priority\": 5287,\n \"id\": \"36ae9a47-6a48-743b-eb71-123064a4313d\"\n },\n {\n \"priority\": 6425,\n \"id\": \"5c1333bc-1707-0031-6089-acb049d90050\"\n }\n ],\n \"locales\": {\n \"key_0\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"key_1\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n },\n \"enable_price_segmentation\": true,\n \"include_draft_products\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "55aa34ba-77de-445e-a5f8-b15f4f3255d4", "name": "The created catalog", "originalRequest": { "url": { "path": [ "catalogs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog\",\n \"attributes\": {\n \"name\": \"catalog-123\",\n \"hierarchy_ids\": [\n \"string\",\n \"string\"\n ],\n \"description\": \"Catalog for Store 123\",\n \"pricebook_id\": \"string\",\n \"pricebook_ids\": [\n {\n \"priority\": 5287,\n \"id\": \"36ae9a47-6a48-743b-eb71-123064a4313d\"\n },\n {\n \"priority\": 6425,\n \"id\": \"5c1333bc-1707-0031-6089-acb049d90050\"\n }\n ],\n \"locales\": {\n \"key_0\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"key_1\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n },\n \"enable_price_segmentation\": true,\n \"include_draft_products\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog\",\n \"attributes\": {\n \"name\": \"catalog-123\",\n \"hierarchy_ids\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"2020-09-22T09:00:00\",\n \"updated_at\": \"2020-09-22T09:00:00\",\n \"description\": \"Catalog for Store 123\",\n \"pricebook_id\": \"string\",\n \"pricebook_ids\": [\n {\n \"priority\": 8763,\n \"id\": \"c2aa4145-55c0-cb37-6d0d-09d51e855cde\"\n },\n {\n \"priority\": 9582,\n \"id\": \"89668d71-12a2-6e58-9122-eae612223774\"\n }\n ],\n \"locales\": {\n \"key_0\": {\n \"key_0\": \"string\"\n }\n },\n \"owner\": \"store\",\n \"enable_price_segmentation\": true,\n \"include_draft_products\": false\n },\n \"relationships\": {\n \"rules\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"releases\": {\n \"links\": {\n \"related\": \"string\"\n },\n \"meta\": {\n \"count\": 1454\n }\n }\n }\n },\n \"links\": {\n \"self\": \"http://FVVlksPTYggXWDASALHgISTzlzq.anAplkALjhT+xx26iiuLgSZ\",\n \"first\": \"https://apbkuObkPxsHSPfcCI.hbdogYiibSzN.GhMKEHI,AprIH3n9Esx\",\n \"last\": \"http://fcF.ahbEt7d1aHBsqzhB9EN0G1MHDHSCeY0pMRtw+sV7HIdp6lC8b\",\n \"prev\": \"https://jOUQVbEyxxAkpsyxZtcvGHwdceYjk.aogLrv6fR+vsvfbUpBP9zGez708bcOg-7zyLg89g+5RMf8R\",\n \"next\": \"https://q.kixppOCEcpfoXO5PFEoZDiPnK8rtcf30-8orA.t8fQZo1\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f49e5e64-bace-4eab-9d54-e5674fb7bfbf", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "catalogs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog\",\n \"attributes\": {\n \"name\": \"catalog-123\",\n \"hierarchy_ids\": [\n \"string\",\n \"string\"\n ],\n \"description\": \"Catalog for Store 123\",\n \"pricebook_id\": \"string\",\n \"pricebook_ids\": [\n {\n \"priority\": 5287,\n \"id\": \"36ae9a47-6a48-743b-eb71-123064a4313d\"\n },\n {\n \"priority\": 6425,\n \"id\": \"5c1333bc-1707-0031-6089-acb049d90050\"\n }\n ],\n \"locales\": {\n \"key_0\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"key_1\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n },\n \"enable_price_segmentation\": true,\n \"include_draft_products\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f071db76-34fc-4643-b977-4a0560633c40", "name": "Gets all authorized catalogs", "request": { "name": "Gets all authorized catalogs", "description": { "content": "Retrieves a list of all the catalogs that you are authorized to view. Currently, published catalogs are limited to the current release and two releases prior to the current release. You can see the differences between the last 2 consecutive catalog releases using the delta link returned in the response of a [publish a catalog](/docs/api/pxm/catalog/publish-release) endpoint.\n\nYou can use the `is_full_delta` attribute returned from the `get a release of a catalog` endpoint to determine if you need to refresh the data in your company system before publishing a catalog release and injecting fresh data in a delta link. The `is_full_delta` attribute tells you if this is a full publish of a catalog release. Using a search service as an example, if the `is_full_delta` attribute is `true`, you should remove all data about that catalog from the search service before publishing a catalog release and injecting fresh data from the delta file. See [Publish a catalog](/docs/api/pxm/catalog/publish-release).\n\nIf the `is_full_publish` attribute returned in the response is `false`, data from the previous catalog release overlaid the existing data in the delta file. The `is_full_publish` attribute is always `true` the first time a catalog is published. When determining whether delta data needs to be refreshed, ignore this attribute and always use the `is_full_delta` attribute.\n\n### Filtering\n\nThis endpoint supports filtering. For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available when filtering on this endpoint.\n\n| Operator | Description | Supported Attributes | Example |\n|:---|:------------------------------------------------------------------------------------------------|:---------------------------------------------------------|:--- |\n| `eq` | Checks if the values of two operands are equal. If they are, the condition is true. | `name`, | `filter=eq(name,some-name)` |\n| `in` | Checks if the values are included in the specified list. If they are, the condition is true. | `name` | `filter=in(name,some-name,some-name2)` |\n| `like` | Checks if the operand contains the specified string. Wildcards are supported | `name` | `filter=like(name,*some-name*)` |\n", "type": "text/plain" }, "url": { "path": [ "catalogs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d0e2e983-656a-411b-b7d4-3868c2ddc68d", "name": "The list of catalogs.", "originalRequest": { "url": { "path": [ "catalogs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "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\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog\",\n \"attributes\": {\n \"name\": \"catalog-123\",\n \"hierarchy_ids\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"2020-09-22T09:00:00\",\n \"updated_at\": \"2020-09-22T09:00:00\",\n \"description\": \"Catalog for Store 123\",\n \"pricebook_id\": \"string\",\n \"pricebook_ids\": [\n {\n \"priority\": 7594,\n \"id\": \"ecdd596e-8508-b161-dae6-6e2806934fee\"\n },\n {\n \"priority\": 6634,\n \"id\": \"ea19c29f-1be8-82fe-b89f-ba51094007dc\"\n }\n ],\n \"locales\": {\n \"key_0\": {\n \"key_0\": \"string\"\n },\n \"key_1\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n }\n },\n \"owner\": \"store\",\n \"enable_price_segmentation\": true,\n \"include_draft_products\": false\n },\n \"relationships\": {\n \"rules\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"releases\": {\n \"links\": {\n \"related\": \"string\"\n },\n \"meta\": {\n \"count\": 6795\n }\n }\n }\n },\n {\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog\",\n \"attributes\": {\n \"name\": \"catalog-123\",\n \"hierarchy_ids\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"2020-09-22T09:00:00\",\n \"updated_at\": \"2020-09-22T09:00:00\",\n \"description\": \"Catalog for Store 123\",\n \"pricebook_id\": \"string\",\n \"pricebook_ids\": [\n {\n \"priority\": 158,\n \"id\": \"b2a3c952-d6b6-d80d-40e1-3579be0b88ca\"\n },\n {\n \"priority\": 5468,\n \"id\": \"f98bb3b8-b052-477c-d378-6d8177d18a28\"\n }\n ],\n \"locales\": {\n \"key_0\": {\n \"key_0\": \"string\"\n },\n \"key_1\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"key_2\": {\n \"key_0\": \"string\"\n }\n },\n \"owner\": \"store\",\n \"enable_price_segmentation\": true,\n \"include_draft_products\": false\n },\n \"relationships\": {\n \"rules\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"releases\": {\n \"links\": {\n \"related\": \"string\"\n },\n \"meta\": {\n \"count\": 8727\n }\n }\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2456\n },\n \"page\": {\n \"limit\": 1923,\n \"offset\": 5548,\n \"current\": 7857,\n \"total\": 5974\n }\n },\n \"links\": {\n \"self\": \"http://EHrSjcJuTptQIpFcuibvALydbpYHsRiY.obfnTrpNDDG3a\",\n \"first\": \"http://sKUoNbwAcczbl.zkvdLfHe\",\n \"last\": \"http://qImzzTdNOiODsrdKbj.qkzwfJzkZROltzX-T9\",\n \"prev\": \"http://nnKFFD.gbxsAysJhinNp1,jVFNGgIP5bT,J,3+mvhzg7t4gnFdpWZIF0wfKtsBtVy,N+FVY.lcxlYmwXk8YUmVHARBPMqblvxixw\",\n \"next\": \"http://rCTfZjgdDFMaKYsmKGPhHjZayXgRB.pcmExCyWxbKEEQe2NCbB4Mttb,t1SoWUYYN6BIzfJxs89yX46a2BBWDlrPYdVBm\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b70ef8d4-f87d-4765-9c33-d8b422e06b34", "name": "An unexpected error.", "originalRequest": { "url": { "path": [ "catalogs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76991961-1f58-409b-9d16-cd66a867de46", "name": "Get a catalog by ID", "request": { "name": "Get a catalog by ID", "description": { "content": "Retrieves the specified catalog.", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b24c139e-5898-4ed2-b29c-31cdfb379706", "name": "The catalog.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" } ] }, "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 \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog\",\n \"attributes\": {\n \"name\": \"catalog-123\",\n \"hierarchy_ids\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"2020-09-22T09:00:00\",\n \"updated_at\": \"2020-09-22T09:00:00\",\n \"description\": \"Catalog for Store 123\",\n \"pricebook_id\": \"string\",\n \"pricebook_ids\": [\n {\n \"priority\": 8763,\n \"id\": \"c2aa4145-55c0-cb37-6d0d-09d51e855cde\"\n },\n {\n \"priority\": 9582,\n \"id\": \"89668d71-12a2-6e58-9122-eae612223774\"\n }\n ],\n \"locales\": {\n \"key_0\": {\n \"key_0\": \"string\"\n }\n },\n \"owner\": \"store\",\n \"enable_price_segmentation\": true,\n \"include_draft_products\": false\n },\n \"relationships\": {\n \"rules\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"releases\": {\n \"links\": {\n \"related\": \"string\"\n },\n \"meta\": {\n \"count\": 1454\n }\n }\n }\n },\n \"links\": {\n \"self\": \"http://FVVlksPTYggXWDASALHgISTzlzq.anAplkALjhT+xx26iiuLgSZ\",\n \"first\": \"https://apbkuObkPxsHSPfcCI.hbdogYiibSzN.GhMKEHI,AprIH3n9Esx\",\n \"last\": \"http://fcF.ahbEt7d1aHBsqzhB9EN0G1MHDHSCeY0pMRtw+sV7HIdp6lC8b\",\n \"prev\": \"https://jOUQVbEyxxAkpsyxZtcvGHwdceYjk.aogLrv6fR+vsvfbUpBP9zGez708bcOg-7zyLg89g+5RMf8R\",\n \"next\": \"https://q.kixppOCEcpfoXO5PFEoZDiPnK8rtcf30-8orA.t8fQZo1\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26761057-cb76-4de5-9c1c-e5d2b2913a26", "name": "An unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68e4b97e-b377-4140-b5eb-685b2739a22f", "name": "Updates a catalog", "request": { "name": "Updates a catalog", "description": { "content": "Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the catalog is not updated.", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog\",\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"attributes\": {\n \"name\": \"catalog-123\",\n \"description\": \"Catalog for Store 123\",\n \"hierarchy_ids\": [\n \"string\",\n \"string\"\n ],\n \"pricebook_id\": \"string\",\n \"pricebook_ids\": [\n {\n \"priority\": 9754,\n \"id\": \"57b3e806-f51b-aed3-d0f0-4c15528d6597\"\n },\n {\n \"priority\": 4169,\n \"id\": \"955b21f8-69f5-9265-b01a-fee589fdd42d\"\n }\n ],\n \"locales\": {\n \"key_0\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"key_1\": {\n \"key_0\": \"string\"\n }\n },\n \"enable_price_segmentation\": true,\n \"include_draft_products\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "55141d2f-1a57-415c-ba0a-cd72e2ab753b", "name": "An updated catalog with the following attributes.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" } ] }, "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 \"data\": {\n \"type\": \"catalog\",\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"attributes\": {\n \"name\": \"catalog-123\",\n \"description\": \"Catalog for Store 123\",\n \"hierarchy_ids\": [\n \"string\",\n \"string\"\n ],\n \"pricebook_id\": \"string\",\n \"pricebook_ids\": [\n {\n \"priority\": 9754,\n \"id\": \"57b3e806-f51b-aed3-d0f0-4c15528d6597\"\n },\n {\n \"priority\": 4169,\n \"id\": \"955b21f8-69f5-9265-b01a-fee589fdd42d\"\n }\n ],\n \"locales\": {\n \"key_0\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"key_1\": {\n \"key_0\": \"string\"\n }\n },\n \"enable_price_segmentation\": true,\n \"include_draft_products\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog\",\n \"attributes\": {\n \"name\": \"catalog-123\",\n \"hierarchy_ids\": [\n \"string\",\n \"string\"\n ],\n \"created_at\": \"2020-09-22T09:00:00\",\n \"updated_at\": \"2020-09-22T09:00:00\",\n \"description\": \"Catalog for Store 123\",\n \"pricebook_id\": \"string\",\n \"pricebook_ids\": [\n {\n \"priority\": 8763,\n \"id\": \"c2aa4145-55c0-cb37-6d0d-09d51e855cde\"\n },\n {\n \"priority\": 9582,\n \"id\": \"89668d71-12a2-6e58-9122-eae612223774\"\n }\n ],\n \"locales\": {\n \"key_0\": {\n \"key_0\": \"string\"\n }\n },\n \"owner\": \"store\",\n \"enable_price_segmentation\": true,\n \"include_draft_products\": false\n },\n \"relationships\": {\n \"rules\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"releases\": {\n \"links\": {\n \"related\": \"string\"\n },\n \"meta\": {\n \"count\": 1454\n }\n }\n }\n },\n \"links\": {\n \"self\": \"http://FVVlksPTYggXWDASALHgISTzlzq.anAplkALjhT+xx26iiuLgSZ\",\n \"first\": \"https://apbkuObkPxsHSPfcCI.hbdogYiibSzN.GhMKEHI,AprIH3n9Esx\",\n \"last\": \"http://fcF.ahbEt7d1aHBsqzhB9EN0G1MHDHSCeY0pMRtw+sV7HIdp6lC8b\",\n \"prev\": \"https://jOUQVbEyxxAkpsyxZtcvGHwdceYjk.aogLrv6fR+vsvfbUpBP9zGez708bcOg-7zyLg89g+5RMf8R\",\n \"next\": \"https://q.kixppOCEcpfoXO5PFEoZDiPnK8rtcf30-8orA.t8fQZo1\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "780ed5eb-3d29-47dd-a226-7b99746dbbd4", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" } ] }, "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 \"data\": {\n \"type\": \"catalog\",\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"attributes\": {\n \"name\": \"catalog-123\",\n \"description\": \"Catalog for Store 123\",\n \"hierarchy_ids\": [\n \"string\",\n \"string\"\n ],\n \"pricebook_id\": \"string\",\n \"pricebook_ids\": [\n {\n \"priority\": 9754,\n \"id\": \"57b3e806-f51b-aed3-d0f0-4c15528d6597\"\n },\n {\n \"priority\": 4169,\n \"id\": \"955b21f8-69f5-9265-b01a-fee589fdd42d\"\n }\n ],\n \"locales\": {\n \"key_0\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"key_1\": {\n \"key_0\": \"string\"\n }\n },\n \"enable_price_segmentation\": true,\n \"include_draft_products\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53b1c5c9-b601-46df-a1f7-ab921e586119", "name": "Deletes a catalog", "request": { "name": "Deletes a catalog", "description": { "content": "Deletes an unpublished catalog. Use [**Delete a Release**](/docs/api/pxm/catalog/delete-release-by-id) and [**Delete All Releases**](/docs/api/pxm/catalog/delete-releases) to delete releases of a catalog. If the catalog is associated with any catalog rules, you must first update the catalog rules to remove the catalog.", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "7d0ef431-e3c3-4c0f-86f9-9846fe88345a", "name": "A 204 response indicates that the catalog has been deleted.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" } ] }, "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": "627d530c-d838-4a23-ba68-3496cef80967", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Releases", "description": "When a catalog is published, a catalog release is created. A catalog release provides a snapshot of the product information taken at the time of publication. You can have one or more catalog releases available in your organization or in your store. If you publish a catalog for your organization, the catalog is available when the store is launched.\n\nIf you have more than one catalog published for your store, use catalog rules to specify when to display each catalog. For example, you can use [**catalog rules**](/docs/api/pxm/catalog/rules) to schedule a catalog to appear during a particular date and time, such as a seasonal catalog. The catalog may have different pricing than the other catalogs.\n\nWhen a catalog is ready to be used in a store, you publish it. You can create and publish catalogs for different contexts and channels.\n\nHere are some pointers to understand a catalogs' lifecycle.\n\n- The default catalog is always the oldest published catalog and must have have at least one release.\n- At any time, the most recent three catalog releases are maintained. Hence, if there is a fourth catalog release, the first catalog release is automatically removed.\n- Until the catalog is published again, the previously created three catalog releases stay permanently.\n- If you want any other catalog to become the default catalog, you must create a catalog rule.\n- If you want the oldest published catalog to become the default catalog, you must remove the catalog rule.\n- Use the `sort_order` value in the `variations` to program your storefront to display the variation options in the order that you want.\n\nHere is a diagram that describes a catalogs' lifecycle:\n\n![Catalogs' Lifecycle](/assets/catalog-lifecycle.png)\n\n### Publishing catalogs\n\nWhen you publish a catalog, the `live` products in the hierarchies appear in a catalog release. A catalog release provides a snapshot of product information taken at the time of publication. You can have one or more catalog releases available in your organization or in your store. If you publish a catalog for your organization, the catalog is available when the store is launched.\n\nIf you have more than one catalog published for your store, use catalog rules to specify when to display each catalog. For example, you can use [catalog rules](/docs/api/pxm/catalog/rules) to schedule a catalog to appear during a particular date and time, such as a seasonal catalog. The catalog may have different pricing than the other catalogs. You can have multiple published catalogs.\n\nWhen a catalog is ready to be used in a store, you publish it. You can create and publish catalogs for different contexts and channels. You can see the differences between the last two consecutive catalog releases. See [Publish a catalog](/docs/api/pxm/catalog/publish-release).\n\nYou retrieve catalogs for your shopper experience by using the [Catalog View API](/docs/api/pxm/catalog/releases).\n", "item": [ { "id": "1df3a398-5e19-46fa-be4b-88119d242f7c", "name": "Get the catalog release as shoppers", "request": { "name": "Get the catalog release as shoppers", "description": { "content": "Returns a list of all published releases of the specified catalog.", "type": "text/plain" }, "url": { "path": [ "catalog" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "de2b5a16-bc6f-45a7-a21f-f11c23e625f6", "name": "The catalog.", "originalRequest": { "url": { "path": [ "catalog" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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 \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"attributes\": {\n \"name\": \"Clothing\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"catalog_id\": \"0194f54d-f2a1-4e33-9a6e-9ec366152490\",\n \"description\": \"Catalog for Store 123\",\n \"hierarchies\": [\n {\n \"id\": \"65477ce0-fcb8-436b-a120-3d57979421dd\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\"\n },\n {\n \"id\": \"65477ce0-fcb8-436b-a120-3d57979421dd\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\"\n }\n ]\n },\n \"relationships\": {\n \"delta\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"products\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchies\": {\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"string\",\n \"meta\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"started_at\": \"1970-01-01T00:00:00.000\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"release_status\": \"PUBLISHED\",\n \"language\": \"en-GB\",\n \"is_full_publish\": false,\n \"is_full_delta\": false,\n \"total_products\": 7884,\n \"total_nodes\": 1301,\n \"percent_completed\": 435,\n \"owner\": \"store\",\n \"price_segmentation_enabled\": false,\n \"includes_draft_products\": false\n }\n },\n \"links\": {\n \"self\": \"http://nMXLpTsWTDYgMgbrFpCLmpX.impWEC94ScP,,Lwh8Und6LaGFE2pk1PD\",\n \"first\": \"http://npJjcdHewAoUUpLnCFvmcTWIQMaUSCt.uwXTDNDDEr\",\n \"last\": \"http://RBGqSCtUIPWAqhEZ.xsdSULw52ODfc6GNJFHXNg1rQ,WzeigZYzD+ZjyXsFs5MbZQkyftNmLHH8dhgdROQ2cpIFzd\",\n \"prev\": \"http://BvCyne.xliwfkp2D6la5blMLSh3oy2eR0H3,WYh,QQWmgMs\",\n \"next\": \"http://QOSbNDiICEvLGt.nginxCzxGwopia0ArrMSOndtkeMje,TDtf,xLqTk9bSizl.FbmXjjpW5A2MVXKeAp9Po\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9974745-e62d-441e-9a11-6a7079e1739c", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "015fc7de-769c-4e20-8caa-dae38f7e8c49", "name": "Publishes a catalog", "request": { "name": "Publishes a catalog", "description": { "content": "\nPublishes a catalog. You must publish a catalog before you can retrieve that catalog in an organization or store. The hierarchies, live products, and prices associated with a published catalog are in read-only mode. If you make a change to these resources, for example, a change to your price book or hierarchies, you need to republish the catalog.\n\nYou can get [a catalog release](/docs/api/pxm/catalog/get-release-by-id) to retrieve a published catalog. Currently, published catalogs are limited to the current release and two releases prior to the current release.\n\nYou can see the differences between the last 2 consecutive catalog releases. This is useful if want to understand how your products have changed in your catalog, ensuring your site search integration is kept up-to-date.\n\nOnce a catalog release has completed publishing, the delta relationship links to the delta document.\n\nThe `delta` links are signed and only valid for 1 hour. Re-reading a catalog release, for example, using [Getting a release of a catalog](/docs/api/pxm/catalog/get-release-by-id) returns a fresh a link.\n\nYou can use the `is_full_delta` attribute returned from the `get a release of a catalog` endpoint to determine if you need to refresh the data in your company system before injecting fresh data in a `delta` link. The `is_full_delta` attribute tells you if this is a full publish of the catalog. Using a search service as an example, if the `is_full_delta` attribute is `true`, you should remove all data about that catalog from the search service before injecting fresh data from the `delta` file. If the `is_full_delta` attribute is `false`, then data from the previous catalog overlays the existing data in the `delta` file. To publish a catalog and inject fresh data in a `delta` link, set `export_full_delta` to `true`.\n\nIf a previous catalog publish date is greater than 90 days, then a full catalog publish is automatically performed. If you publish your catalogs infrequently, Commerce may perform a full publish when you are expecting a delta publish.\n\n:::caution\n\nGenerating a full delta is resource intensive and slows down the publishing process and so should only be performed in certain circumstances, for example, when initializing an integration with a service like Algolia.\n\n:::\n\nThe `is_full_delta` attribute is always `true` the first time a catalog is published. The information is stored in a collection of `json` documents in a compressed file. You can either manually check the file or, for example, use them to automatically update another company system you may have.\n\n- Delta files are only available for 30 days.\n- Delta files are removed when a catalog release is deleted.\n\nEach document has a `delta_type` with one of the following values, depending on whether a product has been deleted, updated or created in a catalog release.\n\n- `delete` describes products deleted from this release of a catalog.\n- `createupdate` describes products updated in this release of a catalog.\n\n### Multi-Store Management Solutions\n\nIn a multi-store management solution.\n\n- You can create organization catalogs. Your organization catalogs are available for your stores to use.\n- Your stores can create their own catalogs.\n- Your stores can create catalogs that have a combination of organization products and store products.\n\nIf you are publishing a catalog in a store that contains resources from an organization, in Commerce Manager, you must enable the **Include Organization Resources in Catalog Publishes** checkbox.\n\n1. Go to **SYSTEM** > **Store Settings**.\n2. Click **General Settings**.\n3. Select **PXM** from the list.\n4. Select the **Include Organization Resources in Catalog Publishes** checkbox.\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"export_full_delta\": true,\n \"include_organization_resources\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "48158bcf-85cf-4837-9a4b-f266ee1267f6", "name": "Publishes a catalog release with the following attributes.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"export_full_delta\": true,\n \"include_organization_resources\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"attributes\": {\n \"name\": \"Clothing\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"catalog_id\": \"0194f54d-f2a1-4e33-9a6e-9ec366152490\",\n \"description\": \"Catalog for Store 123\",\n \"hierarchies\": [\n {\n \"id\": \"65477ce0-fcb8-436b-a120-3d57979421dd\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\"\n },\n {\n \"id\": \"65477ce0-fcb8-436b-a120-3d57979421dd\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\"\n }\n ]\n },\n \"relationships\": {\n \"delta\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"products\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchies\": {\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"string\",\n \"meta\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"started_at\": \"1970-01-01T00:00:00.000\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"release_status\": \"PUBLISHED\",\n \"language\": \"en-GB\",\n \"is_full_publish\": false,\n \"is_full_delta\": false,\n \"total_products\": 7884,\n \"total_nodes\": 1301,\n \"percent_completed\": 435,\n \"owner\": \"store\",\n \"price_segmentation_enabled\": false,\n \"includes_draft_products\": false\n }\n },\n \"links\": {\n \"self\": \"http://nMXLpTsWTDYgMgbrFpCLmpX.impWEC94ScP,,Lwh8Und6LaGFE2pk1PD\",\n \"first\": \"http://npJjcdHewAoUUpLnCFvmcTWIQMaUSCt.uwXTDNDDEr\",\n \"last\": \"http://RBGqSCtUIPWAqhEZ.xsdSULw52ODfc6GNJFHXNg1rQ,WzeigZYzD+ZjyXsFs5MbZQkyftNmLHH8dhgdROQ2cpIFzd\",\n \"prev\": \"http://BvCyne.xliwfkp2D6la5blMLSh3oy2eR0H3,WYh,QQWmgMs\",\n \"next\": \"http://QOSbNDiICEvLGt.nginxCzxGwopia0ArrMSOndtkeMje,TDtf,xLqTk9bSizl.FbmXjjpW5A2MVXKeAp9Po\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a7d96e6-680b-4ae2-a194-577a25085581", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"export_full_delta\": true,\n \"include_organization_resources\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3d84c90-ed37-4e17-91d5-16f564e9a751", "name": "Gets all authorized catalog releases", "request": { "name": "Gets all authorized catalog releases", "description": { "content": "Returns a list of all published releases of the specified catalog. Currently, published catalogs are limited to the current release and two releases prior to the current release. You can see the differences between the last 2 consecutive catalog releases using the `delta` link returned in the response of a `publish a catalog` endpoint.\n\nYou can use the `is_full_delta` attribute returned from the `get a release of a catalog` endpoint to determine if you need to refresh the data in your company system before publishing a catalog release and injecting fresh data in a delta link. The `is_full_delta` attribute tells you if this is a full publish of a catalog release. Using a search service as an example, if the `is_full_delta` attribute is `true`, you should remove all data about that catalog from the search service before publishing a catalog release and injecting fresh data from the delta file. \n\nIf the `is_full_publish` attribute returned in the response is `false`, data from the previous catalog release overlaid the existing data in the delta file. The `is_full_publish` attribute is always `true` the first time a catalog is published. When determining whether delta data needs to be refreshed, ignore this attribute and always use the `is_full_delta` attribute.\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0a03eefc-32ca-4a36-ab4a-5a4610de0fe3", "name": "The list of catalogs.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"attributes\": {\n \"name\": \"Clothing\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"catalog_id\": \"0194f54d-f2a1-4e33-9a6e-9ec366152490\",\n \"description\": \"Catalog for Store 123\",\n \"hierarchies\": [\n {\n \"id\": \"65477ce0-fcb8-436b-a120-3d57979421dd\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\"\n },\n {\n \"id\": \"65477ce0-fcb8-436b-a120-3d57979421dd\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\"\n }\n ]\n },\n \"relationships\": {\n \"delta\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"products\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchies\": {\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"string\",\n \"meta\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"started_at\": \"1970-01-01T00:00:00.000\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"release_status\": \"PENDING\",\n \"language\": \"en-GB\",\n \"is_full_publish\": false,\n \"is_full_delta\": false,\n \"total_products\": 1452,\n \"total_nodes\": 5629,\n \"percent_completed\": 9405,\n \"owner\": \"organization\",\n \"price_segmentation_enabled\": false,\n \"includes_draft_products\": false\n }\n },\n {\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"attributes\": {\n \"name\": \"Clothing\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"catalog_id\": \"0194f54d-f2a1-4e33-9a6e-9ec366152490\",\n \"description\": \"Catalog for Store 123\",\n \"hierarchies\": [\n {\n \"id\": \"65477ce0-fcb8-436b-a120-3d57979421dd\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\"\n },\n {\n \"id\": \"65477ce0-fcb8-436b-a120-3d57979421dd\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\"\n }\n ]\n },\n \"relationships\": {\n \"delta\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"products\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchies\": {\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"string\",\n \"meta\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"started_at\": \"1970-01-01T00:00:00.000\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"release_status\": \"PUBLISHED\",\n \"language\": \"en-GB\",\n \"is_full_publish\": false,\n \"is_full_delta\": false,\n \"total_products\": 7787,\n \"total_nodes\": 3702,\n \"percent_completed\": 1032,\n \"owner\": \"organization\",\n \"price_segmentation_enabled\": true,\n \"includes_draft_products\": false\n }\n }\n ],\n \"links\": {\n \"self\": \"http://SBILibfbmtQL.ctjbU5A3TQ\",\n \"first\": \"http://ufEdEDcFQeVmZKxfyyqAiGF.eonvA4J54oidCwbmBKPiN25,Zh.g\",\n \"last\": \"https://XmH.twuzBQvmEW8xTUTi+qbnmFq\",\n \"prev\": \"http://WfMiaGjctolQZqToyxVNWHuZN.rgscFGv0XcL0wXgNy4XI1dwJfc+qhdxqa,.wClfaXSv+XcUvkY.,-d4O7I,Y1LSzR4JVkRmFhKwMyqhO41k\",\n \"next\": \"http://ObSy.zeYlwtwTKQ7JHUVAq,mA18NFLtsx-EXraSvNtoGSyok4EQvAI8NPWlu\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb1751e4-19f4-4910-91a7-8210cfc81892", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c96c971-db42-4626-869e-8e121f6d4733", "name": "Deletes all releases", "request": { "name": "Deletes all releases", "description": { "content": "Deletes all releases of the specified published catalog.", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "4f9f6278-42c4-49ef-8d58-3cb60f24d980", "name": "A 204 response indicates that the releases have been deleted.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" } ] }, "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": "828642e6-6d2d-4b3e-bbbe-20257a0c2b5a", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abedaeca-9ea5-4a16-b3f5-5e11dc3654ac", "name": "Get a catalog release by ID", "request": { "name": "Get a catalog release by ID", "description": { "content": "Retrieves the specified catalog release.", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1666dd44-5336-4100-9530-0021085bde79", "name": "The catalog.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"attributes\": {\n \"name\": \"Clothing\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"catalog_id\": \"0194f54d-f2a1-4e33-9a6e-9ec366152490\",\n \"description\": \"Catalog for Store 123\",\n \"hierarchies\": [\n {\n \"id\": \"65477ce0-fcb8-436b-a120-3d57979421dd\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\"\n },\n {\n \"id\": \"65477ce0-fcb8-436b-a120-3d57979421dd\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\"\n }\n ]\n },\n \"relationships\": {\n \"delta\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"products\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchies\": {\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"string\",\n \"meta\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"started_at\": \"1970-01-01T00:00:00.000\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"release_status\": \"PUBLISHED\",\n \"language\": \"en-GB\",\n \"is_full_publish\": false,\n \"is_full_delta\": false,\n \"total_products\": 7884,\n \"total_nodes\": 1301,\n \"percent_completed\": 435,\n \"owner\": \"store\",\n \"price_segmentation_enabled\": false,\n \"includes_draft_products\": false\n }\n },\n \"links\": {\n \"self\": \"http://nMXLpTsWTDYgMgbrFpCLmpX.impWEC94ScP,,Lwh8Und6LaGFE2pk1PD\",\n \"first\": \"http://npJjcdHewAoUUpLnCFvmcTWIQMaUSCt.uwXTDNDDEr\",\n \"last\": \"http://RBGqSCtUIPWAqhEZ.xsdSULw52ODfc6GNJFHXNg1rQ,WzeigZYzD+ZjyXsFs5MbZQkyftNmLHH8dhgdROQ2cpIFzd\",\n \"prev\": \"http://BvCyne.xliwfkp2D6la5blMLSh3oy2eR0H3,WYh,QQWmgMs\",\n \"next\": \"http://QOSbNDiICEvLGt.nginxCzxGwopia0ArrMSOndtkeMje,TDtf,xLqTk9bSizl.FbmXjjpW5A2MVXKeAp9Po\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0812b800-baf4-49f8-b7b8-783c9232449a", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c56c1404-aba6-4e8c-bea4-867aaa3f59b2", "name": "Deletes a release", "request": { "name": "Deletes a release", "description": { "content": "Deletes the specified published catalog release.", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "f3bef449-8998-419a-948c-0ad795be0995", "name": "A 204 response indicates that the release has been deleted.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "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": "88b676c1-7e01-4051-bd64-bd21e1cb764d", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Rules", "description": "If your store requires multiple catalogs, add catalog rules to control when a catalog is displayed. A catalog rule contains a catalog plus the criteria under which to display the catalog.\n\n:::caution\n\nYou cannot create catalog rules for organization catalogs.\n\n:::\n\nYou can use catalog rules to schedule a catalog to appear during a particular period, such as on a specific date or during summer. The catalog might offer different pricing during this period. The pricing depends on the associated price book.\n\nThe following scenarios provides a few examples for using catalog rules.\n\n- **Multiple geographical regions**. Display different catalogs in different regions with suitable pricing or combine product hierarchies from two different regions to display in a third region.\n- **Multiple channels**. Display different catalogs based on how a shopper accesses your store, such as through a mobile app or a web storefront.\n- **Direct to business versus direct to customers**. Offer different products and prices for business customers versus retail customers.\n- **Preferred accounts**. Offer special pricing to a group of users while displaying a standard price catalog to other users.\n- **Preferred customers**. Offer special pricing to preferred customers while displaying a standard price catalog to all other shoppers.\n- **Reward programs**. Enable reward programs where catalog prices drop after a certain spending level is reached.\n- **Product sales**. Offer sale items for a limited time.\n- **Standard pricing**. Display a default catalog to the shoppers who do not meet the criteria of the other catalog rules.\n\nYou can define a catalog rule with any of the following criteria.\n\n- **Accounts**. List the accounts that should see a catalog. When a user has logged in with the account, they see the configured catalog.\n- **Customers**. List the customers that should see a catalog. When the customer is logged in, they see the configured catalog.\n- **Channel**. Specify a shopper experience, such as web storefront or mobile app. Set up the channel to retrieve the catalog from the catalog rule that matches that channel.\n- **Other tags**. Create your own user-defined tags. For example, you might want to tag by regions or you might want to distinguish between business and consumer customers.\n\nIf a catalog rule has no criteria defined, it is the default catalog rule.\n\n### Resolving catalog rules\n\nWhen there is a request for a catalog, the store displays the catalog with the rule that matches the most attributes of the shoppers context.\n\nThe request triggers the following steps:\n\n1. Compares the shoppers context against the defined catalog rules.\n1. Determines the best match.\n1. Retrieves the catalog associated with the matching catalog rule.\n\nThe follow examples show how the best match might be resolved:\n\n- A shopper matches one of the `customer_ids` in one catalog rule only. The catalog for that catalog rule is displayed.\n- A shopper matches one of the `customer_ids` in one catalog rule only, but doesnʼt match any of the `tags` specified in that catalog rule. Because there are no other catalog rules for this `customer_id`, the catalog for the catalog rule is displayed because it is the best match.\n- A shopper is browsing a store using the stores mobile app, which matches `channel=mobile` in two catalog rules. The catalog displayed depends on matches with the `tags` or `customer_ids` attributes. If there is no other matching attribute, the first catalog rule found by the store is used. The best practice is to create catalog rules that cover all cases so that you avoid this situation.\n- An unknown shopper is browsing the only channel offered by the seller. The store displays the base catalog.\n", "item": [ { "id": "0fbc7625-3491-4d50-9923-985536033d8b", "name": "Creates a new catalog rule", "request": { "name": "Creates a new catalog rule", "description": { "content": "If you have multiple catalogs, create catalog rule resources. With catalog rules, you can display different catalogs to different shoppers. For example, you can display a preferred pricing catalog to a few special customers. Or you can display one catalog to shoppers using your website and a different catalog to shoppers using your mobile app. Finally, you can define custom criteria by creating tags.\n\n:::note\n\n- If you have one catalog for all customers and channels, you can omit creating this resource.\n- Due to the way catalogs are cached in Commerce, using catalog rules to display catalogs sometimes causes a 5-minute time delay before the catalogs are displayed.\n- You cannot create catalog rules for organization catalogs.\n\n:::\n\nFor ideas about the kinds of business scenarios you can achieve with catalog rules, see [Catalog Rules](/docs/api/pxm/catalog/rules). To understand how catalogs are matched to shoppers by using rules, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n", "type": "text/plain" }, "url": { "path": [ "catalogs", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_rule\",\n \"attributes\": {\n \"name\": \"rule-123\",\n \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\",\n \"description\": \"Catalog Rule for most favored customers\",\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n }\n ],\n \"pricebook_ids\": [\n {\n \"priority\": 8602,\n \"id\": \"ad100ba2-ac9d-5e6f-fc16-a0b92a9d9fee\"\n },\n {\n \"priority\": 2768,\n \"id\": \"8c979bbf-de6c-fd0c-0514-0d160b4e8220\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f07cdcc8-f58c-41a5-ad77-fe78e6ae9e70", "name": "The created catalog rule", "originalRequest": { "url": { "path": [ "catalogs", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_rule\",\n \"attributes\": {\n \"name\": \"rule-123\",\n \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\",\n \"description\": \"Catalog Rule for most favored customers\",\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n }\n ],\n \"pricebook_ids\": [\n {\n \"priority\": 8602,\n \"id\": \"ad100ba2-ac9d-5e6f-fc16-a0b92a9d9fee\"\n },\n {\n \"priority\": 2768,\n \"id\": \"8c979bbf-de6c-fd0c-0514-0d160b4e8220\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog_rule\",\n \"attributes\": {\n \"name\": \"rule-123\",\n \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\",\n \"created_at\": \"2020-09-22T09:00:00\",\n \"updated_at\": \"2020-09-22T09:00:00\",\n \"description\": \"Catalog Rule for most favored customers\",\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n }\n ],\n \"pricebook_ids\": [\n {\n \"priority\": 1360,\n \"id\": \"23cd16ad-378f-88c4-e54a-61f93eeb40c8\"\n },\n {\n \"priority\": 8198,\n \"id\": \"06f1d394-5f3f-ceff-6ffe-33c67c7b8136\"\n }\n ]\n },\n \"meta\": {\n \"similarity_score\": 100,\n \"active\": false,\n \"resolved_for_shopper\": true,\n \"release_id\": \"string\"\n }\n },\n \"links\": {\n \"self\": \"https://k.cvzCKJz-fwEr\",\n \"first\": \"https://in.uexbFBPo6EfsM2Y-TFdZPssAd,x6meMF,9zippQQSyVkmkWeewWmvi6a2jYt\",\n \"last\": \"https://BiSCHickWlGWgZRIdMPJzDDiWlMMYZ.yyiGfO4J8haQUOL6i1qyBK7d7YerkcjSwrKcribcxVUNOq6RY,I\",\n \"prev\": \"http://mvvs.ouoiYrVoVl7b7J.EjaiwwiRVmpKVCnMl+ceXFbRL.+\",\n \"next\": \"http://DgXlpVRC.jfiOY7vI47g-K9gvO2Gf6pX9.CMXoL2s0iixMjtJrnfNnIrSi46dnzg8Iy0ZS\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "843b706c-0864-4b6b-a4fc-ceef2925a8d2", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_rule\",\n \"attributes\": {\n \"name\": \"rule-123\",\n \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\",\n \"description\": \"Catalog Rule for most favored customers\",\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n }\n ],\n \"pricebook_ids\": [\n {\n \"priority\": 8602,\n \"id\": \"ad100ba2-ac9d-5e6f-fc16-a0b92a9d9fee\"\n },\n {\n \"priority\": 2768,\n \"id\": \"8c979bbf-de6c-fd0c-0514-0d160b4e8220\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "435ff03a-2ec6-4730-9bbd-e19ebe0f3bb2", "name": "Gets all authorized catalog rules", "request": { "name": "Gets all authorized catalog rules", "description": { "content": "Retrieves all authorized catalog rules.\n\n### Filtering\n\nThis endpoint supports filtering. For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are supported.\n\n| Operator | Description | Supported Attributes | Example |\n|:--- |:--- |:--- |:--- |\n| `eq` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. | `id`,`catalog_id`,`account_ids`,`customer_ids`,`channels`,`tags`,`pricebook_ids` | `filter=eq(id,some-id)` | \n| `in` | Checks if the values are included in the specified string. If they are, the condition is true. | `id`,`account_ids`,`customer_ids`,`channels`,`tags`,`pricebook_ids` | `filter=in(account_ids,some-id,another-id)` | \n", "type": "text/plain" }, "url": { "path": [ "catalogs", "rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b87d097f-fca8-4109-a3f2-06c48bf54c2f", "name": "The list of catalog rules.", "originalRequest": { "url": { "path": [ "catalogs", "rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "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\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog_rule\",\n \"attributes\": {\n \"name\": \"rule-123\",\n \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\",\n \"created_at\": \"2020-09-22T09:00:00\",\n \"updated_at\": \"2020-09-22T09:00:00\",\n \"description\": \"Catalog Rule for most favored customers\",\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n }\n ],\n \"pricebook_ids\": [\n {\n \"priority\": 1213,\n \"id\": \"51746359-ca73-ab70-dddd-275a9df63fc0\"\n },\n {\n \"priority\": 9314,\n \"id\": \"ce038d5a-cf7b-ee83-8c66-b9c5b8e01869\"\n }\n ]\n },\n \"meta\": {\n \"similarity_score\": 100,\n \"active\": false,\n \"resolved_for_shopper\": true,\n \"release_id\": \"string\"\n }\n },\n {\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog_rule\",\n \"attributes\": {\n \"name\": \"rule-123\",\n \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\",\n \"created_at\": \"2020-09-22T09:00:00\",\n \"updated_at\": \"2020-09-22T09:00:00\",\n \"description\": \"Catalog Rule for most favored customers\",\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n }\n ],\n \"pricebook_ids\": [\n {\n \"priority\": 2333,\n \"id\": \"0c3a6236-b3be-7379-6c8f-c91d27533987\"\n },\n {\n \"priority\": 2875,\n \"id\": \"fb73f84d-744f-5408-683c-5593e37d2207\"\n }\n ]\n },\n \"meta\": {\n \"similarity_score\": 100,\n \"active\": false,\n \"resolved_for_shopper\": true,\n \"release_id\": \"string\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 4702\n },\n \"page\": {\n \"limit\": 3902,\n \"offset\": 3601,\n \"current\": 6988,\n \"total\": 9304\n }\n },\n \"links\": {\n \"self\": \"https://P.oeikfX+sz0NL6vyhOwTtkgnVJsePx8e3w.7-HwFjNRoOc+vkHdEC+\",\n \"first\": \"https://BJGPyCPTIHacKscorbuRmKme.qdzctOntVIP9I.xkMswY\",\n \"last\": \"http://kGXbcAuWFTQedKtAeurrFsUQaP.hdnHVxU5Wt-1e33jHHV4WQOYJXF\",\n \"prev\": \"https://YLgjrEUxpiHs.goPXQ\",\n \"next\": \"https://KDsXTXjFmLfWkBxAROucectNsOGhI.nmYi2UQl9no3HC3LqdJY4TRqQSA.VssKJusuln1ntQ\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53e24dbf-224e-49df-89f5-b632a6e20554", "name": "An unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", "rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ab94ffe-ae30-45cf-9442-02d9e5000fb6", "name": "Get a catalog rule by ID", "request": { "name": "Get a catalog rule by ID", "description": {}, "url": { "path": [ "catalogs", "rules", ":catalog_rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "catalog_rule_id", "disabled": false, "description": { "content": "(Required) The catalog rule ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1665a7d9-0e55-4bdd-9c13-73a1c85d809c", "name": "The catalog rile.", "originalRequest": { "url": { "path": [ "catalogs", "rules", ":catalog_rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog rule ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_rule_id" } ] }, "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 \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog_rule\",\n \"attributes\": {\n \"name\": \"rule-123\",\n \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\",\n \"created_at\": \"2020-09-22T09:00:00\",\n \"updated_at\": \"2020-09-22T09:00:00\",\n \"description\": \"Catalog Rule for most favored customers\",\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n }\n ],\n \"pricebook_ids\": [\n {\n \"priority\": 1360,\n \"id\": \"23cd16ad-378f-88c4-e54a-61f93eeb40c8\"\n },\n {\n \"priority\": 8198,\n \"id\": \"06f1d394-5f3f-ceff-6ffe-33c67c7b8136\"\n }\n ]\n },\n \"meta\": {\n \"similarity_score\": 100,\n \"active\": false,\n \"resolved_for_shopper\": true,\n \"release_id\": \"string\"\n }\n },\n \"links\": {\n \"self\": \"https://k.cvzCKJz-fwEr\",\n \"first\": \"https://in.uexbFBPo6EfsM2Y-TFdZPssAd,x6meMF,9zippQQSyVkmkWeewWmvi6a2jYt\",\n \"last\": \"https://BiSCHickWlGWgZRIdMPJzDDiWlMMYZ.yyiGfO4J8haQUOL6i1qyBK7d7YerkcjSwrKcribcxVUNOq6RY,I\",\n \"prev\": \"http://mvvs.ouoiYrVoVl7b7J.EjaiwwiRVmpKVCnMl+ceXFbRL.+\",\n \"next\": \"http://DgXlpVRC.jfiOY7vI47g-K9gvO2Gf6pX9.CMXoL2s0iixMjtJrnfNnIrSi46dnzg8Iy0ZS\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad048e2c-57be-4e04-bf5c-4c68116b64ef", "name": "An unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", "rules", ":catalog_rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog rule ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_rule_id" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d32ebc6-d6de-4e32-a8d6-0fbb30d83f0e", "name": "Updates a catalog rule", "request": { "name": "Updates a catalog rule", "description": { "content": "Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the catalog rule is not updated.", "type": "text/plain" }, "url": { "path": [ "catalogs", "rules", ":catalog_rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "catalog_rule_id", "disabled": false, "description": { "content": "(Required) The catalog rule ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog_rule\",\n \"attributes\": {\n \"name\": \"rule-123\",\n \"description\": \"Catalog Rule for most favored customers\",\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n }\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\",\n \"pricebook_ids\": [\n {\n \"priority\": 5086,\n \"id\": \"fa3a6aaf-e37c-1a79-7524-9303e47898f4\"\n },\n {\n \"priority\": 593,\n \"id\": \"dad27057-7820-73b2-9a89-d80d6af3e16c\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "369168ad-2a8c-4ab1-a4cb-3d80ffafad0a", "name": "An Updated catalog rule with the following attributes.", "originalRequest": { "url": { "path": [ "catalogs", "rules", ":catalog_rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog rule ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_rule_id" } ] }, "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 \"data\": {\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog_rule\",\n \"attributes\": {\n \"name\": \"rule-123\",\n \"description\": \"Catalog Rule for most favored customers\",\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n }\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\",\n \"pricebook_ids\": [\n {\n \"priority\": 5086,\n \"id\": \"fa3a6aaf-e37c-1a79-7524-9303e47898f4\"\n },\n {\n \"priority\": 593,\n \"id\": \"dad27057-7820-73b2-9a89-d80d6af3e16c\"\n }\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 \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog_rule\",\n \"attributes\": {\n \"name\": \"rule-123\",\n \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\",\n \"created_at\": \"2020-09-22T09:00:00\",\n \"updated_at\": \"2020-09-22T09:00:00\",\n \"description\": \"Catalog Rule for most favored customers\",\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n }\n ],\n \"pricebook_ids\": [\n {\n \"priority\": 1360,\n \"id\": \"23cd16ad-378f-88c4-e54a-61f93eeb40c8\"\n },\n {\n \"priority\": 8198,\n \"id\": \"06f1d394-5f3f-ceff-6ffe-33c67c7b8136\"\n }\n ]\n },\n \"meta\": {\n \"similarity_score\": 100,\n \"active\": false,\n \"resolved_for_shopper\": true,\n \"release_id\": \"string\"\n }\n },\n \"links\": {\n \"self\": \"https://k.cvzCKJz-fwEr\",\n \"first\": \"https://in.uexbFBPo6EfsM2Y-TFdZPssAd,x6meMF,9zippQQSyVkmkWeewWmvi6a2jYt\",\n \"last\": \"https://BiSCHickWlGWgZRIdMPJzDDiWlMMYZ.yyiGfO4J8haQUOL6i1qyBK7d7YerkcjSwrKcribcxVUNOq6RY,I\",\n \"prev\": \"http://mvvs.ouoiYrVoVl7b7J.EjaiwwiRVmpKVCnMl+ceXFbRL.+\",\n \"next\": \"http://DgXlpVRC.jfiOY7vI47g-K9gvO2Gf6pX9.CMXoL2s0iixMjtJrnfNnIrSi46dnzg8Iy0ZS\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6924ec08-f483-4541-a56a-aebb5eb77052", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", "rules", ":catalog_rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog rule ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_rule_id" } ] }, "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 \"data\": {\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog_rule\",\n \"attributes\": {\n \"name\": \"rule-123\",\n \"description\": \"Catalog Rule for most favored customers\",\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n }\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\",\n \"pricebook_ids\": [\n {\n \"priority\": 5086,\n \"id\": \"fa3a6aaf-e37c-1a79-7524-9303e47898f4\"\n },\n {\n \"priority\": 593,\n \"id\": \"dad27057-7820-73b2-9a89-d80d6af3e16c\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b012e6ad-4a7e-485b-8b08-e88f70b45ed5", "name": "Deletes a catalog rule", "request": { "name": "Deletes a catalog rule", "description": {}, "url": { "path": [ "catalogs", "rules", ":catalog_rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "catalog_rule_id", "disabled": false, "description": { "content": "(Required) The catalog rule ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "c695210e-127f-48c7-9325-cd551ed59826", "name": "A 204 response indicates that the catalog rule has been deleted.", "originalRequest": { "url": { "path": [ "catalogs", "rules", ":catalog_rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog rule ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_rule_id" } ] }, "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": "2105adce-5438-4ed9-b614-3a0e2bcda252", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", "rules", ":catalog_rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog rule ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_rule_id" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53db15c7-d637-4230-afc6-f173fa297c48", "name": "Validate catalog rules for a given context", "request": { "name": "Validate catalog rules for a given context", "description": { "content": "Validates catalog rules for a given context and returns a list of matching catalog rules.\n", "type": "text/plain" }, "url": { "path": [ "catalogs", "rules", "validate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"match_type\": \"resolve_for_shopper\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"pricebook_ids\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2001-12-26T08:01:46.439Z\",\n \"valid_to\": \"1954-02-06T01:45:54.701Z\"\n },\n {\n \"valid_from\": \"2017-12-08T12:51:09.651Z\",\n \"valid_to\": \"1960-05-07T04:04:19.296Z\"\n }\n ],\n \"name\": \"string\",\n \"catalog_id\": \"string\",\n \"match_date\": \"1971-03-14T17:01:28.113Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bc5e6014-b475-4f7d-a7b1-b9cb4ea1af50", "name": "List of matching catalog rules", "originalRequest": { "url": { "path": [ "catalogs", "rules", "validate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"match_type\": \"resolve_for_shopper\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"pricebook_ids\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2001-12-26T08:01:46.439Z\",\n \"valid_to\": \"1954-02-06T01:45:54.701Z\"\n },\n {\n \"valid_from\": \"2017-12-08T12:51:09.651Z\",\n \"valid_to\": \"1960-05-07T04:04:19.296Z\"\n }\n ],\n \"name\": \"string\",\n \"catalog_id\": \"string\",\n \"match_date\": \"1971-03-14T17:01:28.113Z\"\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\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog_rule\",\n \"attributes\": {\n \"name\": \"rule-123\",\n \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\",\n \"created_at\": \"2020-09-22T09:00:00\",\n \"updated_at\": \"2020-09-22T09:00:00\",\n \"description\": \"Catalog Rule for most favored customers\",\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n }\n ],\n \"pricebook_ids\": [\n {\n \"priority\": 1213,\n \"id\": \"51746359-ca73-ab70-dddd-275a9df63fc0\"\n },\n {\n \"priority\": 9314,\n \"id\": \"ce038d5a-cf7b-ee83-8c66-b9c5b8e01869\"\n }\n ]\n },\n \"meta\": {\n \"similarity_score\": 100,\n \"active\": false,\n \"resolved_for_shopper\": true,\n \"release_id\": \"string\"\n }\n },\n {\n \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"type\": \"catalog_rule\",\n \"attributes\": {\n \"name\": \"rule-123\",\n \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\",\n \"created_at\": \"2020-09-22T09:00:00\",\n \"updated_at\": \"2020-09-22T09:00:00\",\n \"description\": \"Catalog Rule for most favored customers\",\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n }\n ],\n \"pricebook_ids\": [\n {\n \"priority\": 2333,\n \"id\": \"0c3a6236-b3be-7379-6c8f-c91d27533987\"\n },\n {\n \"priority\": 2875,\n \"id\": \"fb73f84d-744f-5408-683c-5593e37d2207\"\n }\n ]\n },\n \"meta\": {\n \"similarity_score\": 100,\n \"active\": false,\n \"resolved_for_shopper\": true,\n \"release_id\": \"string\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 4702\n },\n \"page\": {\n \"limit\": 3902,\n \"offset\": 3601,\n \"current\": 6988,\n \"total\": 9304\n }\n },\n \"links\": {\n \"self\": \"https://P.oeikfX+sz0NL6vyhOwTtkgnVJsePx8e3w.7-HwFjNRoOc+vkHdEC+\",\n \"first\": \"https://BJGPyCPTIHacKscorbuRmKme.qdzctOntVIP9I.xkMswY\",\n \"last\": \"http://kGXbcAuWFTQedKtAeurrFsUQaP.hdnHVxU5Wt-1e33jHHV4WQOYJXF\",\n \"prev\": \"https://YLgjrEUxpiHs.goPXQ\",\n \"next\": \"https://KDsXTXjFmLfWkBxAROucectNsOGhI.nmYi2UQl9no3HC3LqdJY4TRqQSA.VssKJusuln1ntQ\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfd0de63-b226-40d4-bbf9-e8cc45307fb0", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", "rules", "validate" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"match_type\": \"resolve_for_shopper\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"account_ids\": [\n \"string\",\n \"string\"\n ],\n \"account_tag_ids\": [\n \"string\",\n \"string\"\n ],\n \"customer_ids\": [\n \"string\",\n \"string\"\n ],\n \"pricebook_ids\": [\n \"string\",\n \"string\"\n ],\n \"schedules\": [\n {\n \"valid_from\": \"2001-12-26T08:01:46.439Z\",\n \"valid_to\": \"1954-02-06T01:45:54.701Z\"\n },\n {\n \"valid_from\": \"2017-12-08T12:51:09.651Z\",\n \"valid_to\": \"1960-05-07T04:04:19.296Z\"\n }\n ],\n \"name\": \"string\",\n \"catalog_id\": \"string\",\n \"match_date\": \"1971-03-14T17:01:28.113Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Administrator Latest Releases Catalog API", "description": "Use the Administrator Latest Releases Catalog View API to retrieve product, hierarchy and node information.\n\n:::danger\n\nThe Administrator Latest Releases Catalog View API is for Administrator use only. Do not use these endpoints on your customer-facing frontends.\n\n:::\n\nPublishing a catalog creates a release of that catalog that you can use in an organization or in a specific store or other shopper experience. You can retrieve the hierarchies, nodes, and the `live` products associated with a catalog release. You can see which parent nodes a product is associated with. This is useful if want to improve how your shoppers search your store, for example.\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n", "item": [ { "id": "8000b24e-0dd1-45ee-b398-879984d5d187", "name": "Get all Hierarchies", "request": { "name": "Get all Hierarchies", "description": { "content": "Returns the hierarchies from a published catalog.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\n| Operator | Description | Supported Attributes | Example |\n|:--- |:--- |:--- |:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. | `name`, `slug`| `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. | `id` | `filter=in(id,some-id)` | \n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "\nThis endpoints supports filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4e373c3b-9dec-4a73-bebb-c1c38983cfea", "name": "The hierarchies of a catalog.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "\nThis endpoints supports filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 2162\n },\n \"page\": {\n \"limit\": 1925,\n \"offset\": 5775,\n \"current\": 7170,\n \"total\": 7457\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"nodes\": {\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"hierarchy\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"nodes\": {\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"hierarchy\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n }\n ],\n \"links\": {\n \"self\": \"https://neOrRhGgbaUXnVPjNEHATtSy.htuvGQBBURTrvKOJwlxktH.Qy\",\n \"first\": \"https://wSHFFMlzTOIbSu.fvmYmDktf4n\",\n \"last\": \"http://qlLgAbHtsxZLhTPluoGnRWjyNj.jdSQu-Z0tN22pCv1lKek8mwRjyQnluXYQSrjjEpGoWQACDm2DV+f7-I\",\n \"prev\": \"https://DkyzXVrGlQcqSHkpiqvW.zwbmlwfbDPhTnHlNcg,DITA61+Cacq5PcUuKphJ.esy0\",\n \"next\": \"http://YIZditehdTFZElBtcbHwyOVNmEaOwyZxk.upQDFTjrbrawhcfu.fE\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2128f0c1-1dd5-4734-a6eb-835a921f01fb", "name": "An unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "\nThis endpoints supports filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "db1e4d39-e53a-4284-91f2-4b4c7d74de36", "name": "Get a Hierarchy", "request": { "name": "Get a Hierarchy", "description": { "content": "Returns the specified hierarchy from a published catalog.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies", ":hierarchy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "hierarchy_id", "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "49b753ba-4071-48d3-bd9b-f47a05dc788c", "name": "The catalog hierarchy.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies", ":hierarchy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"nodes\": {\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"hierarchy\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n \"links\": {\n \"self\": \"https://DMJfF.zuaIydyW5\",\n \"first\": \"https://pxqrGlHpWHnVNoXAIf.eum9vQ2sC93MDdczEHT\",\n \"last\": \"http://KuWjfUPXcveEdFUI.horrnOytb.hzWoN,nu0SO\",\n \"prev\": \"http://KDohTOythVYmmqCyRAzOjltkgLbDrA.cmmlKo7WawDjDzF\",\n \"next\": \"http://XKXELiQqFDnGwYmGhbS.uxbqp3Yv9kePn27s-M1mbbFpM.+VaBkLMYX2Q.JNgP8BG\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "429bb29f-4225-4a6a-ada4-c833ef7fce89", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies", ":hierarchy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e111cf17-63e5-4822-99e8-b497db3278fc", "name": "Get a Hierarchy's Nodes", "request": { "name": "Get a Hierarchy's Nodes", "description": { "content": "Returns all nodes for the specified hierarchy from a published catalog.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\nIn the `breadcrumbs` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\n| Operator | Description | Supported Attributes | Example |\n|:--- |:--- |:--- |:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. | `name`, `slug`| `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. | `id` | `filter=in(id,some-id)` | \n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies", ":hierarchy_id", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "hierarchy_id", "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5f2edc5c-858e-444c-be23-249eae87b208", "name": "The child nodes of a catalog hierarchy.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies", ":hierarchy_id", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 8983\n },\n \"page\": {\n \"limit\": 4298,\n \"offset\": 4318,\n \"current\": 1324,\n \"total\": 3299\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"b8e41b00-643d-ad5e-31b5-0477c57c1766\",\n \"type\": \"product\"\n },\n {\n \"id\": \"bbf36e7f-4dec-9f74-f797-0603753b0990\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"842c0629-3d2f-f057-ad7e-00898efe5f3f\",\n \"type\": \"product\"\n },\n {\n \"id\": \"b328d2d6-76b1-573a-05c8-54ba17cf79a8\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n }\n ],\n \"links\": {\n \"self\": \"https://YxDMYYIhWEosvoL.vjhDbr2HmbdeKZlIRf,Yv8V,mXvksH5TsgcItKMnggk1HLcOf20KX.N3iS\",\n \"first\": \"http://oVGoEFGPUXVPACqmvSTkCCuaBTCw.rrtD.n6DNhKxMvJelSUokuxcUWiGQPtJZHDaeO4vl3I.eAOS9de9wch\",\n \"last\": \"http://PcqFLAQBBiIWLklXxX.riVUBUI0kNHVVydfuYoT39w2WI\",\n \"prev\": \"https://y.tjMrk35P1p\",\n \"next\": \"http://gQliuCHkeysJIbrBmBfhlBNHpPmCHupLZ.hbRRvIlF,6Jdk.rg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73a76de4-6b8a-459b-b55c-c2a8aa431e56", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies", ":hierarchy_id", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef99965d-d927-4e0f-bbf0-2055bb10a6fb", "name": "Get a Hierarchy's Children", "request": { "name": "Get a Hierarchy's Children", "description": { "content": "Returns the parent nodes for the specified hierarchy from a published catalog.\n\n![Parent Nodes](/assets/rootnodes.PNG)\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\nIn the `breadcrumbs` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\n| Operator | Description | Supported Attributes | Example |\n|:--- |:--- |:--- |:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. | `name`, `slug`| `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. | `id` | `filter=in(id,some-id)` | \n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies", ":hierarchy_id", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "hierarchy_id", "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f7159acf-2beb-4157-98f4-687618a0d8dc", "name": "The child nodes of a catalog hierarchy.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies", ":hierarchy_id", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 8983\n },\n \"page\": {\n \"limit\": 4298,\n \"offset\": 4318,\n \"current\": 1324,\n \"total\": 3299\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"b8e41b00-643d-ad5e-31b5-0477c57c1766\",\n \"type\": \"product\"\n },\n {\n \"id\": \"bbf36e7f-4dec-9f74-f797-0603753b0990\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"842c0629-3d2f-f057-ad7e-00898efe5f3f\",\n \"type\": \"product\"\n },\n {\n \"id\": \"b328d2d6-76b1-573a-05c8-54ba17cf79a8\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n }\n ],\n \"links\": {\n \"self\": \"https://YxDMYYIhWEosvoL.vjhDbr2HmbdeKZlIRf,Yv8V,mXvksH5TsgcItKMnggk1HLcOf20KX.N3iS\",\n \"first\": \"http://oVGoEFGPUXVPACqmvSTkCCuaBTCw.rrtD.n6DNhKxMvJelSUokuxcUWiGQPtJZHDaeO4vl3I.eAOS9de9wch\",\n \"last\": \"http://PcqFLAQBBiIWLklXxX.riVUBUI0kNHVVydfuYoT39w2WI\",\n \"prev\": \"https://y.tjMrk35P1p\",\n \"next\": \"http://gQliuCHkeysJIbrBmBfhlBNHpPmCHupLZ.hbRRvIlF,6Jdk.rg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "262b0f0d-c341-47a7-bbdb-69a7b597c3f2", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies", ":hierarchy_id", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0aafde7a-d47e-41f0-83ca-19998ab4f3d2", "name": "Get all Nodes", "request": { "name": "Get all Nodes", "description": { "content": "Returns the child nodes from a published catalog.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\nYou can see the parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\nIn a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. See [Building breadcrumbs in a storefront](#building-breadcrumbs-in-a-storefront).\n\nThe response lists the products associated with the nodes. If products are [curated](/guides/How-To/Products/curating-products), they are displayed in `curated_products`. Product curation allows you to promote specific products within each of your hierarchies, enabling you to create unique product collections in your storefront.\n\n- If you don't provide any `curated_products`, products are listed by their `updated_at` time in descending order, with the most recently updated product first.\n- If you configure `curated_products` for only a few products, the curated products are displayed first and the other products are displayed in the order of `updated_at` time.\n- You can only curate 20 products or less. You cannot have more than 20 curated products.\n- If a curated product is removed from a node, the product is also removed from the `curated_products` list.\n- A product that is curated has the `\"curated_product\": true` attribute displayed.\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available.\n\n| Operator | Description | Attributes | Example |\n| --- | --- | --- | --- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. | `name`, `slug` | `filter=eq(name,some-name)` |\n| `in` | Checks if the values are included in the specified string. If they are, the condition is true.\n| `Id` | `filter=in(id,9214719b-17fe-4ea7-896c-d61e60fc0d05,e104d541-2c52-47fa-8a9a-c4382480d97c,65daaf68-ff2e-4632-8944-370de835967d)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f8390dab-2a7d-4636-817e-b271e6fc90ec", "name": "The nodes of a catalog.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 8983\n },\n \"page\": {\n \"limit\": 4298,\n \"offset\": 4318,\n \"current\": 1324,\n \"total\": 3299\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"b8e41b00-643d-ad5e-31b5-0477c57c1766\",\n \"type\": \"product\"\n },\n {\n \"id\": \"bbf36e7f-4dec-9f74-f797-0603753b0990\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"842c0629-3d2f-f057-ad7e-00898efe5f3f\",\n \"type\": \"product\"\n },\n {\n \"id\": \"b328d2d6-76b1-573a-05c8-54ba17cf79a8\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n }\n ],\n \"links\": {\n \"self\": \"https://YxDMYYIhWEosvoL.vjhDbr2HmbdeKZlIRf,Yv8V,mXvksH5TsgcItKMnggk1HLcOf20KX.N3iS\",\n \"first\": \"http://oVGoEFGPUXVPACqmvSTkCCuaBTCw.rrtD.n6DNhKxMvJelSUokuxcUWiGQPtJZHDaeO4vl3I.eAOS9de9wch\",\n \"last\": \"http://PcqFLAQBBiIWLklXxX.riVUBUI0kNHVVydfuYoT39w2WI\",\n \"prev\": \"https://y.tjMrk35P1p\",\n \"next\": \"http://gQliuCHkeysJIbrBmBfhlBNHpPmCHupLZ.hbRRvIlF,6Jdk.rg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb326647-3e88-44f5-9d11-99c84dd36be9", "name": "An unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "805e00b5-8e74-47fd-a9a8-ff069a7828f7", "name": "Get a Node", "request": { "name": "Get a Node", "description": { "content": "Returns a node from a published catalog.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\nYou can see the parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\nThe response lists the products associated with the nodes. If products are [curated](/guides/How-To/Products/curating-products), they are displayed in `curated_products`. Product curation allows you to promote specific products within each of your hierarchies, enabling you to create unique product collections in your storefront.\n\n- If you don't provide any `curated_products`, products are listed by their `updated_at` time in descending order, with the most recently updated product first.\n- If you configure `curated_products` for only a few products, the curated products are displayed first and the other products are displayed in the order of `updated_at` time.\n- You can only curate 20 products or less. You cannot have more than 20 curated products.\n- If a curated product is removed from a node, the product is also removed from the `curated_products` list.\n- A product that is curated has the `\"curated_product\": true` attribute displayed.\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "nodes", ":node_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "node_id", "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "67ab83fe-6c2d-45eb-bc86-d98227f38a4c", "name": "The catalog node.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "nodes", ":node_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "node_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"693d4e46-3045-ea49-236e-300416befc4d\",\n \"type\": \"product\"\n },\n {\n \"id\": \"3767d926-965b-5009-45dd-a13597c74636\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n \"links\": {\n \"self\": \"http://ZeNrnffUUjESdbNGwRiZdhTzRw.wkwvn36vvnq2bpCMLkcK12uGwyKsKZDd.A,cfORDLbVufTkmXgQ+6fDkHX0-uNCDxQkMXRbqh\",\n \"first\": \"http://GAQgehZHViwliCTfbDOiMLHcWI.mvBihwMOGiuI1PvV6PRLtHFFHfW5\",\n \"last\": \"https://OuaQBNecxRrBmPDblBDf.vxxa6qsEpl24Df-Y\",\n \"prev\": \"http://RLfydyACYWuiHkZ.baHkNxYIPxRMzKyMgibOYuZdzy7fQKVZFM0sK6tK.wjnFdp6Hc7d\",\n \"next\": \"https://IXiFarPGluyGTMIFkYvLHWKgSfhQPuYs.itpLO-JuAoV+jSVVEXDez-kIPGFwf+CFXBIILc-Kdefwe\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32c41424-e4cf-47c5-8de2-2f217652e0b4", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "nodes", ":node_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "node_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6cda8955-264d-4d6f-851a-8fa2c80b4e20", "name": "Get a Node's Children", "request": { "name": "Get a Node's Children", "description": { "content": "Returns the child nodes for a node from a published catalog.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\nYou can see the parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\nIn a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. For more information, see [Building breadcrumbs in a storefront](#building-breadcrumbs-in-a-storefront).\n\nThe response lists the products associated with the nodes. If products are [curated](/guides/How-To/Products/curating-products), they are displayed in `curated_products`. Product curation allows you to promote specific products within each of your hierarchies, enabling you to create unique product collections in your storefront.\n\n- If you don't provide any `curated_products`, products are listed by their `updated_at` time in descending order, with the most recently updated product first.\n- If you configure `curated_products` for only a few products, the curated products are displayed first and the other products are displayed in the order of `updated_at` time.\n- You can only curate 20 products or less. You cannot have more than 20 curated products.\n- If a curated product is removed from a node, the product is also removed from the `curated_products` list.\n- A product that is curated has the `\"curated_product\": true` attribute displayed.\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available.\n\n| Operator | Description | Attributes | Example |\n| --- | --- | --- | --- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. | `name`, `slug` | `filter=eq(name,some-name)` |\n| `in` | Checks if the values are included in the specified string. If they are, the condition is true.\n| `Id` | `filter=in(id,9214719b-17fe-4ea7-896c-d61e60fc0d05,e104d541-2c52-47fa-8a9a-c4382480d97c,65daaf68-ff2e-4632-8944-370de835967d)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "nodes", ":node_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "node_id", "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "436828c7-e972-4ca8-a072-cbd255995306", "name": "The child nodes of a catalog node.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "nodes", ":node_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "node_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 8983\n },\n \"page\": {\n \"limit\": 4298,\n \"offset\": 4318,\n \"current\": 1324,\n \"total\": 3299\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"b8e41b00-643d-ad5e-31b5-0477c57c1766\",\n \"type\": \"product\"\n },\n {\n \"id\": \"bbf36e7f-4dec-9f74-f797-0603753b0990\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"842c0629-3d2f-f057-ad7e-00898efe5f3f\",\n \"type\": \"product\"\n },\n {\n \"id\": \"b328d2d6-76b1-573a-05c8-54ba17cf79a8\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n }\n ],\n \"links\": {\n \"self\": \"https://YxDMYYIhWEosvoL.vjhDbr2HmbdeKZlIRf,Yv8V,mXvksH5TsgcItKMnggk1HLcOf20KX.N3iS\",\n \"first\": \"http://oVGoEFGPUXVPACqmvSTkCCuaBTCw.rrtD.n6DNhKxMvJelSUokuxcUWiGQPtJZHDaeO4vl3I.eAOS9de9wch\",\n \"last\": \"http://PcqFLAQBBiIWLklXxX.riVUBUI0kNHVVydfuYoT39w2WI\",\n \"prev\": \"https://y.tjMrk35P1p\",\n \"next\": \"http://gQliuCHkeysJIbrBmBfhlBNHpPmCHupLZ.hbRRvIlF,6Jdk.rg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e6a170c-b6c6-486f-b5c1-aef2de0ff285", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "nodes", ":node_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "node_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b0bcb5b-4fa5-4c6c-b0a3-b6511ee25b81", "name": "Get all Products", "request": { "name": "Get all Products", "description": { "content": "Returns the products from a published catalog. Only the products in a `live` status are retrieved. Currently, published catalogs are limited to the current release and two releases prior to the current release.\n\nYou can see the parent nodes a product is associated with in the `bread_crumbs` and `bread_crumb_nodes` metadata for each product. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\nThe `variations` object lists the variation IDs and variation option IDs and their corresponding product IDs that are generated when the variation and variation options are built with a product. The `variations` object can then be added to your catalogs. By default, variations and variation options are sorted randomly. You can use the `sort_order` attribute to sort the order of your variation and variation options in `variations`. Once a parent product is published in a catalog, the [Get a List of products in a catalog release](/docs/api/pxm/catalog/get-all-products) response displays the sorted variations and variation options. Variations and variation options are displayed in descending order according to their `sort_order` values.\n\n### Including Resources\n\nUsing the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug. \n\n| Parameter | Required | Description |\n| :---------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n| `files` | Optional | Any files associated with a product. \n\nSee [**Including Resources**](/guides/Getting-Started/includes).\n\n### Filtering\n\nThis endpoint supports filtering. For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available when filtering on this endpoint.\n\n| Operator | Description | Supported Attributes | Example |\n|:---|:------------------------------------------------------------------------------------------------|:---------------------------------------------------------|:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. For `product_types`, you can only specify one product type. For example, `filter=eq(product_types,child)`. | `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. For `product_types`, you can specify more than one product type. For example, `filter=in(product_types,child,bundle)`. | `id`, `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=in(id,some-id)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "445e4919-6a81-4a24-96d2-0d17e3a42797", "name": "The products of a catalog.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 7816\n },\n \"page\": {\n \"limit\": 9938,\n \"offset\": 2759,\n \"current\": 3857,\n \"total\": 8528\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7437,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 906,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 8590,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 8280,\n \"max\": 4438,\n \"sort_order\": 2552,\n \"options\": [\n {\n \"id\": \"61b67cf2-fe07-34be-6264-d708074a00c7\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8673,\n \"max\": 4691,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 4468,\n \"max\": 372,\n \"sort_order\": 6765,\n \"options\": [\n {\n \"id\": \"dad1dade-cde5-2d28-6636-40011309b2ab\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 4253,\n \"max\": 4813,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"min\": 9092,\n \"max\": 3207,\n \"sort_order\": 3349,\n \"options\": [\n {\n \"id\": \"8a96e778-da9e-171e-e0c8-3e2e7ac14ba2\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 6673,\n \"max\": 9572,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_3\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"9e2847d9-9fee-ee3e-d6b6-5f862246225e\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"cd595518-6f3c-8ddc-2160-168a949f2896\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"d70f2291-edfb-09d9-1a4b-d5424c826322\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"3fbcce08-7b2f-dc70-0088-4a0400ee39a0\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"949eb60b-3151-55b9-5a85-59fa828f0313\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"76df8064-b687-81ae-4389-0a6207318d21\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"key_1\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2281,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 602,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5442,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3389,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8594,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3047,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1933,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9942,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8372,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6466,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2035,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4614,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 884,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1063,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 831,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9680,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9852,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7182,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1700,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5728,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9236,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3352,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5317,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2798,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2617,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3714,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3410,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9279,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4730,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 498,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2078,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4873,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9320,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3640,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7604,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7834,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5130,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9310,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 94,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7453,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9512,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7192,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9289,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5967,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4427,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_3\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2948,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6436,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 312,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9765,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4485,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8613,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7079,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7152,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9169,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4336,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6877,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_4\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8492,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7277,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2062,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6232,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4753,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7600,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6722,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1567,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6885,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3865,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6384,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4037,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6849,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7322,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1857,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6271,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3544,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6677,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7729,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8195,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5624,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3380,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9324,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 459,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3205,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7535,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"98290a18-56fa-b336-0fe8-d0458638f88e\",\n \"name\": \"string\",\n \"sort_order\": 7685,\n \"option\": {\n \"id\": \"0d5ce731-10a0-b21f-15e5-ad36a5123722\",\n \"name\": \"string\",\n \"sort_order\": 5798,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"04b82f37-2401-4f42-7bdf-12d9c92ebe2c\",\n \"name\": \"string\",\n \"sort_order\": 9578,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"a267e97a-eab4-5a91-d312-5656b9d78054\",\n \"name\": \"string\",\n \"sort_order\": 3664,\n \"option\": {\n \"id\": \"eb12f1b2-8aac-71e5-3bcf-8f6685ead395\",\n \"name\": \"string\",\n \"sort_order\": 5622,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a7030cc1-9dfc-1462-9da1-05f16512a956\",\n \"name\": \"string\",\n \"sort_order\": 96,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7615,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 6845,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2422,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3570,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5840,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6553,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9815,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 724,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4997,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"included\": {\n \"main_images\": [\n {\n \"id\": \"e2c28b7e-d10e-6abb-4169-cd2482b03dfc\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ],\n \"component_products\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 2757,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5175,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 9406,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_3\": {\n \"minimum_quantity\": 5575,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 4553,\n \"max\": 5413,\n \"sort_order\": 2201,\n \"options\": [\n {\n \"id\": \"531186ce-3551-b846-bfa2-24d3fa804525\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8666,\n \"max\": 9305,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 6028,\n \"max\": 1133,\n \"sort_order\": 766,\n \"options\": [\n {\n \"id\": \"3af4bc55-dba0-1d41-c35a-0040411b6d62\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8867,\n \"max\": 5613,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"key_1\": {\n \"key_0\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"3c0577d5-5cb8-39d5-466e-b38d395a30c9\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"4616afd1-d81a-979b-ad01-e949628faa37\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"7fed1852-ea36-fa23-e8c2-a5761a4bcab8\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"aa66f582-8678-4585-4e71-a22fc4d82ae9\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"21d6dee3-1a4a-2d1f-218a-035b25557064\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"c88f5127-6b73-9195-d969-85e512db2c66\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4659,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3397,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 771,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4666,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9433,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1247,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8151,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8223,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1233,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1231,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8939,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5217,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5456,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7595,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9643,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3137,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 9752,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7647,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"a4c951fa-76e5-6426-1d40-7868ad13b38e\",\n \"name\": \"string\",\n \"sort_order\": 3161,\n \"option\": {\n \"id\": \"66a61f50-3514-0597-2b22-5e90ec32a9e7\",\n \"name\": \"string\",\n \"sort_order\": 7689,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"8a81f24d-eb2f-3e06-2457-7317697f2c15\",\n \"name\": \"string\",\n \"sort_order\": 6710,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"74ee4ab1-01cf-75fc-55c1-0d2a7977025e\",\n \"name\": \"string\",\n \"sort_order\": 8035,\n \"option\": {\n \"id\": \"d263aeca-6e19-2788-68b9-c3dd41aa1eb4\",\n \"name\": \"string\",\n \"sort_order\": 699,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a0fb8143-3b95-7104-5c5a-ad8c0505fe18\",\n \"name\": \"string\",\n \"sort_order\": 7985,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_3\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 501,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5604,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 513,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8460,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5511,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1817,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5851,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8316,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9126,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"files\": [\n {\n \"id\": \"eb7875b5-9133-e233-06a2-944cf6386a23\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"http://aXr.tkxnTbewPf-TSyfpFNdVQzKR1LZVqoG+w\",\n \"first\": \"http://tRHN.ltbMsPtrVEmTAVv+7aZVwEY+oQDiEB9NtHOnUy6ZMOxY6Wwc2pLRCx5NNA7dKxoFhu2rDnUpZCwPQyeZ3C\",\n \"last\": \"https://DqmxTwrhgHRhRldsRouVkU.tfiykl6c3SAC2MOs49EE6StQj8yJjQMWEuBpNfH7JLtUwjrO-uxzzRax4OHXYd,7M\",\n \"prev\": \"https://xlrXOmcnFODEXKWF.fkyum1CqXkuiTTF0Uvw7AJ.5ycueWt50Tr8EuPddYTDo-w1gg09+uw,hYD6-ujV\",\n \"next\": \"https://oZjEHmBMoOeaaM.eho9abmyifrTEBG8gBiQx9K5NepybIZg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aace0dfa-d515-413f-98bb-89c9de6a4c4b", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac32a40e-c3a6-4729-b498-8db133ef1dd0", "name": "Get a Product", "request": { "name": "Get a Product", "description": { "content": "Returns a product from a published catalog. The product must be in `live` status. Currently, published catalogs are limited to the current release and two releases prior to the current release.\n\n### Product and Node Associations in Breadcrumb Metadata\n\nYou can see the parent nodes a product is associated with in the `bread_crumbs` and `bread_crumb_nodes` metadata for each product. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\n### Product Variations\n\nThe `variations` object lists the variation IDs and variation option IDs and their corresponding product IDs that are generated when the variation and variation options are built with a product. The `variations` object can then be added to your catalogs. By default, variations and variation options are sorted randomly. You can use the `sort_order`attribute to sort the order of your variation and variation options in `variations`. Once a parent product is published in a catalog, the get a product in a catalog release response displays the sorted variations and variation options. Variations and variation options are displayed in descending order according to their `sort_order` values.\n\n### Including Resources\n\nUsing the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug. \n\n| Parameter | Required | Description |\n| :---------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n| `files` | Optional | Any files associated with a product. \n\nSee [**Including Resources**](/guides/Getting-Started/includes).\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "product_id", "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "12b7e9b7-1c28-4a73-aceb-2c64b82b3867", "name": "The product of a catalog.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "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 \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 6853,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 6663,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 9406,\n \"max\": 1125,\n \"sort_order\": 954,\n \"options\": [\n {\n \"id\": \"b7351151-061f-5c95-727e-944e01606adc\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 1842,\n \"max\": 1895,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 9234,\n \"max\": 7866,\n \"sort_order\": 237,\n \"options\": [\n {\n \"id\": \"347e7804-6e75-ec83-7e6d-2e88f1be96fe\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 7959,\n \"max\": 9678,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_3\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"key_1\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"a39becc8-b70b-1b2a-0090-5abe3bac60e8\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"f31fee2c-5b74-824c-1cba-fef1579b959c\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"05bd6ee7-7cd1-31a9-b336-0bf099cf77ce\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"9b236558-4a0c-b086-4d14-e5a29ee18af8\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"d9d662af-1997-c788-200b-9955f158259c\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"bf68ce53-021b-6147-45d7-4aeb8853be29\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8633,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6991,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5059,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5445,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 272,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7054,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3990,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2724,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8460,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9555,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2487,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7868,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1323,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3259,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3583,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7703,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9114,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6740,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4839,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4425,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 526,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6443,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1283,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4204,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5923,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1373,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1644,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2615,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6061,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3329,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3907,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1364,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9920,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1087,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8236,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2009,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6510,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7080,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7513,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9666,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"712b9df1-d4bd-42cd-b535-c8dfc49a5827\",\n \"name\": \"string\",\n \"sort_order\": 7061,\n \"option\": {\n \"id\": \"9f5a59aa-0842-d16f-0a05-4bb18765bbf9\",\n \"name\": \"string\",\n \"sort_order\": 7333,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"8403562a-9eaa-a139-7527-f47d9f45f1d5\",\n \"name\": \"string\",\n \"sort_order\": 9655,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"341e10e6-ff09-791f-c510-afff3ce38855\",\n \"name\": \"string\",\n \"sort_order\": 3357,\n \"option\": {\n \"id\": \"5344ead3-f3e6-e3ba-f3b1-b57d92b4451f\",\n \"name\": \"string\",\n \"sort_order\": 7687,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"cc2538a0-c57f-ed21-94e4-49681bcfeb86\",\n \"name\": \"string\",\n \"sort_order\": 4566,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5524,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 857,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3726,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6501,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4611,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4492,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4050,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 9720,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 696,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3527,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3125,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4262,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5308,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6532,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5430,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1779,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1092,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n },\n \"included\": {\n \"main_images\": [\n {\n \"id\": \"0c803ef4-fc47-d6c3-8bff-31523f576b68\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ],\n \"component_products\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 6826,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5333,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 7158,\n \"max\": 8863,\n \"sort_order\": 8611,\n \"options\": [\n {\n \"id\": \"d6d4ed14-82af-2478-d1aa-72a4a4a509ef\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 1775,\n \"max\": 1203,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 2614,\n \"max\": 6909,\n \"sort_order\": 6541,\n \"options\": [\n {\n \"id\": \"22d64e53-752b-3757-ab5e-d7d343b6b3e8\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 3588,\n \"max\": 6457,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"48f81978-ab05-815c-13f1-cf369700a2fc\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"539cb49f-156d-161d-c6ba-59667ec4a21d\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"a7d33abf-390f-22bf-44d2-da02abb9d654\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"25d51cc8-fd7e-3c80-a7b6-f0629221daf8\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"9759fbd0-af6e-8c28-077d-ef6a9045585a\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"9f304c63-90d4-e23f-3d2a-a566b272c717\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"key_1\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1915,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3150,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7748,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2794,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9454,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6890,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3114,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4813,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7026,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9105,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5076,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9026,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5633,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9587,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8222,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6925,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7159,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5370,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4991,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7038,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3287,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2277,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6870,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3266,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"80a92e9a-3c1c-8036-d382-a081a0df9267\",\n \"name\": \"string\",\n \"sort_order\": 8637,\n \"option\": {\n \"id\": \"9b7c86a3-87e2-b0fe-0e5d-6e50a98ff2ee\",\n \"name\": \"string\",\n \"sort_order\": 6052,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"1303e5d7-2893-1750-0232-f2fc53d86cf8\",\n \"name\": \"string\",\n \"sort_order\": 4035,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"5261e7ac-3210-47c3-c35c-08da7cb85ffc\",\n \"name\": \"string\",\n \"sort_order\": 6618,\n \"option\": {\n \"id\": \"59fc31d6-8726-8884-d485-c5bca11ea294\",\n \"name\": \"string\",\n \"sort_order\": 7785,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"9c566c3d-0137-3aed-999d-47773583050a\",\n \"name\": \"string\",\n \"sort_order\": 268,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5997,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7911,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6716,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4694,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2556,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2051,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6971,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1284,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8299,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 58,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6269,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3713,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8049,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"files\": [\n {\n \"id\": \"ae847ec3-4e7e-cbde-4b24-9c6303a03b0b\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"https://Wm.fgWRmWIJ8XWE2jtiD-HLffY3rT3xNLgnkM9ipCQ+0LVwH6C.SB,XsbyCAEHDbGSdB\",\n \"first\": \"https://vdRSUFSJk.lccsAVXA20Mh9JIB8WGF7xh7Wc1BbLpQ.+d\",\n \"last\": \"https://RYWRItdrAbDIPgRWnyGZaqpENRaXOsLW.zoAAC+9NFSXzPdv4,djR-UFNKu1JQPW,GxMDNXbbuJW.Y8RN7qz3i32izRxnxwAXrz\",\n \"prev\": \"https://CHamHQbMatK.jhqkX1yKF3fsNPJcxEMm-I2k-mitukoDnvx9awe9aRH4o6rppC\",\n \"next\": \"http://EgXGFFigWzhfFScVazdwaXPX.cyFj94G+-LMJQmMc.HVtUH40SZGjabFDw\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a8a8433-e926-4dd6-9092-c1cc498e5a26", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e7a145b-2600-4a5e-9e81-581c447c080b", "name": "Get all Related Products of a Product", "request": { "name": "Get all Related Products of a Product", "description": { "content": "Returns related products of the provided product ID from a published catalog.\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products", ":product_id", "relationships", ":custom_relationship_slug", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "product_id", "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "custom_relationship_slug", "disabled": false, "description": { "content": "(Required) The custom relationship slug.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "598fe30a-f4ac-4970-aa3e-b97a299e46e3", "name": "The related products of a catalog.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products", ":product_id", "relationships", ":custom_relationship_slug", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" }, { "disabled": false, "description": { "content": "(Required) The custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "string", "key": "custom_relationship_slug" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 7816\n },\n \"page\": {\n \"limit\": 9938,\n \"offset\": 2759,\n \"current\": 3857,\n \"total\": 8528\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7437,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 906,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 8590,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 8280,\n \"max\": 4438,\n \"sort_order\": 2552,\n \"options\": [\n {\n \"id\": \"61b67cf2-fe07-34be-6264-d708074a00c7\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8673,\n \"max\": 4691,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 4468,\n \"max\": 372,\n \"sort_order\": 6765,\n \"options\": [\n {\n \"id\": \"dad1dade-cde5-2d28-6636-40011309b2ab\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 4253,\n \"max\": 4813,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"min\": 9092,\n \"max\": 3207,\n \"sort_order\": 3349,\n \"options\": [\n {\n \"id\": \"8a96e778-da9e-171e-e0c8-3e2e7ac14ba2\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 6673,\n \"max\": 9572,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_3\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"9e2847d9-9fee-ee3e-d6b6-5f862246225e\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"cd595518-6f3c-8ddc-2160-168a949f2896\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"d70f2291-edfb-09d9-1a4b-d5424c826322\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"3fbcce08-7b2f-dc70-0088-4a0400ee39a0\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"949eb60b-3151-55b9-5a85-59fa828f0313\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"76df8064-b687-81ae-4389-0a6207318d21\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"key_1\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2281,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 602,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5442,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3389,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8594,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3047,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1933,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9942,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8372,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6466,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2035,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4614,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 884,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1063,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 831,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9680,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9852,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7182,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1700,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5728,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9236,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3352,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5317,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2798,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2617,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3714,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3410,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9279,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4730,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 498,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2078,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4873,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9320,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3640,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7604,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7834,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5130,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9310,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 94,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7453,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9512,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7192,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9289,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5967,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4427,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_3\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2948,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6436,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 312,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9765,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4485,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8613,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7079,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7152,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9169,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4336,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6877,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_4\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8492,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7277,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2062,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6232,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4753,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7600,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6722,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1567,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6885,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3865,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6384,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4037,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6849,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7322,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1857,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6271,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3544,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6677,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7729,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8195,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5624,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3380,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9324,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 459,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3205,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7535,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"98290a18-56fa-b336-0fe8-d0458638f88e\",\n \"name\": \"string\",\n \"sort_order\": 7685,\n \"option\": {\n \"id\": \"0d5ce731-10a0-b21f-15e5-ad36a5123722\",\n \"name\": \"string\",\n \"sort_order\": 5798,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"04b82f37-2401-4f42-7bdf-12d9c92ebe2c\",\n \"name\": \"string\",\n \"sort_order\": 9578,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"a267e97a-eab4-5a91-d312-5656b9d78054\",\n \"name\": \"string\",\n \"sort_order\": 3664,\n \"option\": {\n \"id\": \"eb12f1b2-8aac-71e5-3bcf-8f6685ead395\",\n \"name\": \"string\",\n \"sort_order\": 5622,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a7030cc1-9dfc-1462-9da1-05f16512a956\",\n \"name\": \"string\",\n \"sort_order\": 96,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7615,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 6845,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2422,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3570,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5840,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6553,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9815,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 724,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4997,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"included\": {\n \"main_images\": [\n {\n \"id\": \"e2c28b7e-d10e-6abb-4169-cd2482b03dfc\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ],\n \"component_products\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 2757,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5175,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 9406,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_3\": {\n \"minimum_quantity\": 5575,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 4553,\n \"max\": 5413,\n \"sort_order\": 2201,\n \"options\": [\n {\n \"id\": \"531186ce-3551-b846-bfa2-24d3fa804525\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8666,\n \"max\": 9305,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 6028,\n \"max\": 1133,\n \"sort_order\": 766,\n \"options\": [\n {\n \"id\": \"3af4bc55-dba0-1d41-c35a-0040411b6d62\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8867,\n \"max\": 5613,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"key_1\": {\n \"key_0\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"3c0577d5-5cb8-39d5-466e-b38d395a30c9\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"4616afd1-d81a-979b-ad01-e949628faa37\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"7fed1852-ea36-fa23-e8c2-a5761a4bcab8\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"aa66f582-8678-4585-4e71-a22fc4d82ae9\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"21d6dee3-1a4a-2d1f-218a-035b25557064\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"c88f5127-6b73-9195-d969-85e512db2c66\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4659,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3397,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 771,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4666,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9433,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1247,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8151,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8223,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1233,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1231,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8939,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5217,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5456,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7595,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9643,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3137,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 9752,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7647,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"a4c951fa-76e5-6426-1d40-7868ad13b38e\",\n \"name\": \"string\",\n \"sort_order\": 3161,\n \"option\": {\n \"id\": \"66a61f50-3514-0597-2b22-5e90ec32a9e7\",\n \"name\": \"string\",\n \"sort_order\": 7689,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"8a81f24d-eb2f-3e06-2457-7317697f2c15\",\n \"name\": \"string\",\n \"sort_order\": 6710,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"74ee4ab1-01cf-75fc-55c1-0d2a7977025e\",\n \"name\": \"string\",\n \"sort_order\": 8035,\n \"option\": {\n \"id\": \"d263aeca-6e19-2788-68b9-c3dd41aa1eb4\",\n \"name\": \"string\",\n \"sort_order\": 699,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a0fb8143-3b95-7104-5c5a-ad8c0505fe18\",\n \"name\": \"string\",\n \"sort_order\": 7985,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_3\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 501,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5604,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 513,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8460,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5511,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1817,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5851,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8316,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9126,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"files\": [\n {\n \"id\": \"eb7875b5-9133-e233-06a2-944cf6386a23\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"http://aXr.tkxnTbewPf-TSyfpFNdVQzKR1LZVqoG+w\",\n \"first\": \"http://tRHN.ltbMsPtrVEmTAVv+7aZVwEY+oQDiEB9NtHOnUy6ZMOxY6Wwc2pLRCx5NNA7dKxoFhu2rDnUpZCwPQyeZ3C\",\n \"last\": \"https://DqmxTwrhgHRhRldsRouVkU.tfiykl6c3SAC2MOs49EE6StQj8yJjQMWEuBpNfH7JLtUwjrO-uxzzRax4OHXYd,7M\",\n \"prev\": \"https://xlrXOmcnFODEXKWF.fkyum1CqXkuiTTF0Uvw7AJ.5ycueWt50Tr8EuPddYTDo-w1gg09+uw,hYD6-ujV\",\n \"next\": \"https://oZjEHmBMoOeaaM.eho9abmyifrTEBG8gBiQx9K5NepybIZg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3677b191-ac4d-4f38-9b87-546ac85ca7ff", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products", ":product_id", "relationships", ":custom_relationship_slug", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" }, { "disabled": false, "description": { "content": "(Required) The custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "string", "key": "custom_relationship_slug" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "428e9c9e-7320-431d-847e-ebd1b8360070", "name": "Get a Bundle's Component Products", "request": { "name": "Get a Bundle's Component Products", "description": { "content": "With Product Experience Manager, you can [create](/docs/api/pxm/products/create-product) and manage bundles. A bundle is a purchasable product, comprising of one or more products that you want to sell together. \n\nYou can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity.\n\nThis endpoint returns a list of component product IDs for the specified bundle.\n\n### Including Resources\n\nUsing the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug. \n\n| Parameter | Required | Description |\n| :---------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n| `files` | Optional | Any files associated with a product. |\n\nSee [**Including Resources**](/guides/Getting-Started/includes).\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products", ":product_id", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "product_id", "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ac3e588b-83e8-4fc0-99b0-a761164fddca", "name": "The list of component product IDs of a specific bundle product from a catalog.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products", ":product_id", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 5732\n },\n \"page\": {\n \"limit\": 5381,\n \"offset\": 2712,\n \"current\": 1973,\n \"total\": 2778\n }\n },\n \"data\": [\n {\n \"id\": \"be1166ed-7aec-0652-d239-775554db95c7\",\n \"type\": \"product\"\n },\n {\n \"id\": \"11b5c1cf-fc7c-a6ca-ba70-1cf13078d19e\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"http://HDEKtwXFNCbDKnocl.ultEf0lMRnmFDn794BVRmtOBhioqcI7sNG2kKXT,NwOpv4PoNaMqmpKANUTXyW.+86SirDVcx-J\",\n \"first\": \"https://bMJuhuHMlFYQzPtlkgOPOnZJejcYT.oanHVUajWDy\",\n \"last\": \"https://nLxjAsbWanlfemHVBCEVhQEPwKYWAG.nyFDPRk5GcVyLy-hMqkOwHoDEjtcTq\",\n \"prev\": \"http://FOnuoefFrASQIfyQJ.umdqyGLLdUisH84GY-UmcCuN7Ed,BOSWEmZC5cBPa5XjGl9zH51gxjfBR-6eIVUo\",\n \"next\": \"http://bbx.ateSg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "817511c1-8b6d-4905-9c12-dd461b9dfa58", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products", ":product_id", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ce5bddf-244a-4a4d-9e55-9788d9a89136", "name": "Get a Parent Product's Child Products", "request": { "name": "Get a Parent Product's Child Products", "description": { "content": "For a specified product and catalog release, retrieves a list of child products from a parent product. Any product other than a base product results in a `422 Unprocessable Entity` response. Only the products in a `live` status are retrieved.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. If no catalog rules are configured, the first catalog found is returned. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nYou can see the parent nodes a product is associated within the breadcrumbs metadata for each product. For example, this is useful if you want to improve how your shoppers search your store. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\n### Filtering\n\nThis endpoint supports filtering. For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available when filtering on this endpoint.\n\n| Operator | Description | Supported Attributes | Example |\n|:---|:------------------------------------------------------------------------------------------------|:---------------------------------------------------------|:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. For `product_types`, you can only specify one product type. For example, `filter=eq(product_types,child)`. | `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. For `product_types`, you can specify more than one product type. For example, `filter=in(product_types,child,bundle)`. | `id`, `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=in(id,some-id)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n\n### Including Resources\n\nUsing the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug. \n\n| Parameter | Required | Description |\n| :---------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n| `files` | Optional | Any files associated with a product. |\n\nSee [**Including Resources**](/guides/Getting-Started/includes).\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products", ":product_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "product_id", "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b3e35ef8-3663-416d-a8f9-c7e78f235698", "name": "The list of child products of a specific base product from a catalog.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products", ":product_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 7816\n },\n \"page\": {\n \"limit\": 9938,\n \"offset\": 2759,\n \"current\": 3857,\n \"total\": 8528\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7437,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 906,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 8590,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 8280,\n \"max\": 4438,\n \"sort_order\": 2552,\n \"options\": [\n {\n \"id\": \"61b67cf2-fe07-34be-6264-d708074a00c7\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8673,\n \"max\": 4691,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 4468,\n \"max\": 372,\n \"sort_order\": 6765,\n \"options\": [\n {\n \"id\": \"dad1dade-cde5-2d28-6636-40011309b2ab\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 4253,\n \"max\": 4813,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"min\": 9092,\n \"max\": 3207,\n \"sort_order\": 3349,\n \"options\": [\n {\n \"id\": \"8a96e778-da9e-171e-e0c8-3e2e7ac14ba2\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 6673,\n \"max\": 9572,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_3\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"9e2847d9-9fee-ee3e-d6b6-5f862246225e\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"cd595518-6f3c-8ddc-2160-168a949f2896\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"d70f2291-edfb-09d9-1a4b-d5424c826322\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"3fbcce08-7b2f-dc70-0088-4a0400ee39a0\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"949eb60b-3151-55b9-5a85-59fa828f0313\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"76df8064-b687-81ae-4389-0a6207318d21\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"key_1\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2281,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 602,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5442,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3389,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8594,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3047,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1933,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9942,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8372,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6466,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2035,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4614,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 884,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1063,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 831,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9680,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9852,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7182,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1700,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5728,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9236,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3352,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5317,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2798,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2617,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3714,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3410,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9279,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4730,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 498,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2078,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4873,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9320,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3640,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7604,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7834,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5130,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9310,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 94,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7453,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9512,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7192,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9289,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5967,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4427,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_3\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2948,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6436,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 312,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9765,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4485,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8613,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7079,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7152,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9169,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4336,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6877,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_4\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8492,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7277,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2062,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6232,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4753,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7600,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6722,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1567,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6885,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3865,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6384,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4037,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6849,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7322,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1857,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6271,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3544,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6677,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7729,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8195,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5624,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3380,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9324,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 459,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3205,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7535,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"98290a18-56fa-b336-0fe8-d0458638f88e\",\n \"name\": \"string\",\n \"sort_order\": 7685,\n \"option\": {\n \"id\": \"0d5ce731-10a0-b21f-15e5-ad36a5123722\",\n \"name\": \"string\",\n \"sort_order\": 5798,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"04b82f37-2401-4f42-7bdf-12d9c92ebe2c\",\n \"name\": \"string\",\n \"sort_order\": 9578,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"a267e97a-eab4-5a91-d312-5656b9d78054\",\n \"name\": \"string\",\n \"sort_order\": 3664,\n \"option\": {\n \"id\": \"eb12f1b2-8aac-71e5-3bcf-8f6685ead395\",\n \"name\": \"string\",\n \"sort_order\": 5622,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a7030cc1-9dfc-1462-9da1-05f16512a956\",\n \"name\": \"string\",\n \"sort_order\": 96,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7615,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 6845,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2422,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3570,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5840,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6553,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9815,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 724,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4997,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"included\": {\n \"main_images\": [\n {\n \"id\": \"e2c28b7e-d10e-6abb-4169-cd2482b03dfc\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ],\n \"component_products\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 2757,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5175,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 9406,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_3\": {\n \"minimum_quantity\": 5575,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 4553,\n \"max\": 5413,\n \"sort_order\": 2201,\n \"options\": [\n {\n \"id\": \"531186ce-3551-b846-bfa2-24d3fa804525\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8666,\n \"max\": 9305,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 6028,\n \"max\": 1133,\n \"sort_order\": 766,\n \"options\": [\n {\n \"id\": \"3af4bc55-dba0-1d41-c35a-0040411b6d62\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8867,\n \"max\": 5613,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"key_1\": {\n \"key_0\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"3c0577d5-5cb8-39d5-466e-b38d395a30c9\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"4616afd1-d81a-979b-ad01-e949628faa37\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"7fed1852-ea36-fa23-e8c2-a5761a4bcab8\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"aa66f582-8678-4585-4e71-a22fc4d82ae9\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"21d6dee3-1a4a-2d1f-218a-035b25557064\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"c88f5127-6b73-9195-d969-85e512db2c66\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4659,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3397,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 771,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4666,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9433,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1247,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8151,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8223,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1233,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1231,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8939,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5217,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5456,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7595,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9643,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3137,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 9752,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7647,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"a4c951fa-76e5-6426-1d40-7868ad13b38e\",\n \"name\": \"string\",\n \"sort_order\": 3161,\n \"option\": {\n \"id\": \"66a61f50-3514-0597-2b22-5e90ec32a9e7\",\n \"name\": \"string\",\n \"sort_order\": 7689,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"8a81f24d-eb2f-3e06-2457-7317697f2c15\",\n \"name\": \"string\",\n \"sort_order\": 6710,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"74ee4ab1-01cf-75fc-55c1-0d2a7977025e\",\n \"name\": \"string\",\n \"sort_order\": 8035,\n \"option\": {\n \"id\": \"d263aeca-6e19-2788-68b9-c3dd41aa1eb4\",\n \"name\": \"string\",\n \"sort_order\": 699,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a0fb8143-3b95-7104-5c5a-ad8c0505fe18\",\n \"name\": \"string\",\n \"sort_order\": 7985,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_3\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 501,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5604,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 513,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8460,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5511,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1817,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5851,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8316,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9126,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"files\": [\n {\n \"id\": \"eb7875b5-9133-e233-06a2-944cf6386a23\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"http://aXr.tkxnTbewPf-TSyfpFNdVQzKR1LZVqoG+w\",\n \"first\": \"http://tRHN.ltbMsPtrVEmTAVv+7aZVwEY+oQDiEB9NtHOnUy6ZMOxY6Wwc2pLRCx5NNA7dKxoFhu2rDnUpZCwPQyeZ3C\",\n \"last\": \"https://DqmxTwrhgHRhRldsRouVkU.tfiykl6c3SAC2MOs49EE6StQj8yJjQMWEuBpNfH7JLtUwjrO-uxzzRax4OHXYd,7M\",\n \"prev\": \"https://xlrXOmcnFODEXKWF.fkyum1CqXkuiTTF0Uvw7AJ.5ycueWt50Tr8EuPddYTDo-w1gg09+uw,hYD6-ujV\",\n \"next\": \"https://oZjEHmBMoOeaaM.eho9abmyifrTEBG8gBiQx9K5NepybIZg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2acedd5c-ab14-43e8-b6d3-ab3e9abedca6", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "products", ":product_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75d80447-4a12-46f3-9f69-71fc4afed06e", "name": "Get a Hierarchy's Products", "request": { "name": "Get a Hierarchy's Products", "description": { "content": "Returns the products associated with the specified hierarchy in the catalog. The products must be in the `live` status.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. See [Resolving catalog rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nYou can see the parent nodes a product is associated with in the `bread_crumbs` and `bread_crumb_nodes` metadata for each product. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\nThe `variations` object lists the variation IDs and variation option IDs and their corresponding product IDs that are generated when the variation and variation options are built with a product. The variations object can then be added to your catalogs. By default, variations and variation options are sorted randomly. You can use the `sort_order` attribute to sort the order of your variation and variation options in variations. Once a parent product is published in a catalog, the [Get a List of products in a catalog](/docs/api/pxm/catalog/get-all-products) release response displays the sorted variations and variation options. Variations and variation options are displayed in descending order according to their `sort_order` values.\n\n### Filtering\n\nThis endpoint supports filtering. For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available when filtering on this endpoint.\n\n| Operator | Description | Supported Attributes | Example |\n|:---|:------------------------------------------------------------------------------------------------|:---------------------------------------------------------|:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. For `product_types`, you can only specify one product type. For example, `filter=eq(product_types,child)`. | `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. For `product_types`, you can specify more than one product type. For example, `filter=in(product_types,child,bundle)`. | `id`, `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=in(id,some-id)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n\n### Including Resources\n\nUsing the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug. \n\n| Parameter | Required | Description |\n| :---------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n| `files` | Optional | Any files associated with a product. |\n\nSee [**Including Resources**](/guides/Getting-Started/includes).\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies", ":hierarchy_id", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "hierarchy_id", "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "60d3572e-b7a0-4dc6-a2f2-0431fada1978", "name": "The products of a catalog hierarchy.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies", ":hierarchy_id", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 7816\n },\n \"page\": {\n \"limit\": 9938,\n \"offset\": 2759,\n \"current\": 3857,\n \"total\": 8528\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7437,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 906,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 8590,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 8280,\n \"max\": 4438,\n \"sort_order\": 2552,\n \"options\": [\n {\n \"id\": \"61b67cf2-fe07-34be-6264-d708074a00c7\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8673,\n \"max\": 4691,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 4468,\n \"max\": 372,\n \"sort_order\": 6765,\n \"options\": [\n {\n \"id\": \"dad1dade-cde5-2d28-6636-40011309b2ab\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 4253,\n \"max\": 4813,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"min\": 9092,\n \"max\": 3207,\n \"sort_order\": 3349,\n \"options\": [\n {\n \"id\": \"8a96e778-da9e-171e-e0c8-3e2e7ac14ba2\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 6673,\n \"max\": 9572,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_3\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"9e2847d9-9fee-ee3e-d6b6-5f862246225e\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"cd595518-6f3c-8ddc-2160-168a949f2896\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"d70f2291-edfb-09d9-1a4b-d5424c826322\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"3fbcce08-7b2f-dc70-0088-4a0400ee39a0\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"949eb60b-3151-55b9-5a85-59fa828f0313\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"76df8064-b687-81ae-4389-0a6207318d21\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"key_1\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2281,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 602,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5442,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3389,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8594,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3047,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1933,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9942,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8372,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6466,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2035,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4614,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 884,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1063,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 831,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9680,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9852,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7182,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1700,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5728,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9236,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3352,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5317,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2798,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2617,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3714,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3410,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9279,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4730,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 498,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2078,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4873,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9320,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3640,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7604,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7834,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5130,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9310,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 94,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7453,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9512,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7192,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9289,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5967,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4427,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_3\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2948,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6436,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 312,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9765,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4485,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8613,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7079,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7152,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9169,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4336,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6877,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_4\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8492,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7277,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2062,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6232,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4753,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7600,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6722,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1567,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6885,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3865,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6384,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4037,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6849,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7322,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1857,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6271,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3544,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6677,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7729,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8195,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5624,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3380,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9324,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 459,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3205,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7535,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"98290a18-56fa-b336-0fe8-d0458638f88e\",\n \"name\": \"string\",\n \"sort_order\": 7685,\n \"option\": {\n \"id\": \"0d5ce731-10a0-b21f-15e5-ad36a5123722\",\n \"name\": \"string\",\n \"sort_order\": 5798,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"04b82f37-2401-4f42-7bdf-12d9c92ebe2c\",\n \"name\": \"string\",\n \"sort_order\": 9578,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"a267e97a-eab4-5a91-d312-5656b9d78054\",\n \"name\": \"string\",\n \"sort_order\": 3664,\n \"option\": {\n \"id\": \"eb12f1b2-8aac-71e5-3bcf-8f6685ead395\",\n \"name\": \"string\",\n \"sort_order\": 5622,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a7030cc1-9dfc-1462-9da1-05f16512a956\",\n \"name\": \"string\",\n \"sort_order\": 96,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7615,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 6845,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2422,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3570,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5840,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6553,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9815,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 724,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4997,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"included\": {\n \"main_images\": [\n {\n \"id\": \"e2c28b7e-d10e-6abb-4169-cd2482b03dfc\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ],\n \"component_products\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 2757,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5175,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 9406,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_3\": {\n \"minimum_quantity\": 5575,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 4553,\n \"max\": 5413,\n \"sort_order\": 2201,\n \"options\": [\n {\n \"id\": \"531186ce-3551-b846-bfa2-24d3fa804525\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8666,\n \"max\": 9305,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 6028,\n \"max\": 1133,\n \"sort_order\": 766,\n \"options\": [\n {\n \"id\": \"3af4bc55-dba0-1d41-c35a-0040411b6d62\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8867,\n \"max\": 5613,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"key_1\": {\n \"key_0\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"3c0577d5-5cb8-39d5-466e-b38d395a30c9\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"4616afd1-d81a-979b-ad01-e949628faa37\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"7fed1852-ea36-fa23-e8c2-a5761a4bcab8\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"aa66f582-8678-4585-4e71-a22fc4d82ae9\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"21d6dee3-1a4a-2d1f-218a-035b25557064\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"c88f5127-6b73-9195-d969-85e512db2c66\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4659,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3397,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 771,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4666,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9433,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1247,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8151,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8223,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1233,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1231,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8939,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5217,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5456,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7595,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9643,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3137,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 9752,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7647,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"a4c951fa-76e5-6426-1d40-7868ad13b38e\",\n \"name\": \"string\",\n \"sort_order\": 3161,\n \"option\": {\n \"id\": \"66a61f50-3514-0597-2b22-5e90ec32a9e7\",\n \"name\": \"string\",\n \"sort_order\": 7689,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"8a81f24d-eb2f-3e06-2457-7317697f2c15\",\n \"name\": \"string\",\n \"sort_order\": 6710,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"74ee4ab1-01cf-75fc-55c1-0d2a7977025e\",\n \"name\": \"string\",\n \"sort_order\": 8035,\n \"option\": {\n \"id\": \"d263aeca-6e19-2788-68b9-c3dd41aa1eb4\",\n \"name\": \"string\",\n \"sort_order\": 699,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a0fb8143-3b95-7104-5c5a-ad8c0505fe18\",\n \"name\": \"string\",\n \"sort_order\": 7985,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_3\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 501,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5604,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 513,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8460,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5511,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1817,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5851,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8316,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9126,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"files\": [\n {\n \"id\": \"eb7875b5-9133-e233-06a2-944cf6386a23\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"http://aXr.tkxnTbewPf-TSyfpFNdVQzKR1LZVqoG+w\",\n \"first\": \"http://tRHN.ltbMsPtrVEmTAVv+7aZVwEY+oQDiEB9NtHOnUy6ZMOxY6Wwc2pLRCx5NNA7dKxoFhu2rDnUpZCwPQyeZ3C\",\n \"last\": \"https://DqmxTwrhgHRhRldsRouVkU.tfiykl6c3SAC2MOs49EE6StQj8yJjQMWEuBpNfH7JLtUwjrO-uxzzRax4OHXYd,7M\",\n \"prev\": \"https://xlrXOmcnFODEXKWF.fkyum1CqXkuiTTF0Uvw7AJ.5ycueWt50Tr8EuPddYTDo-w1gg09+uw,hYD6-ujV\",\n \"next\": \"https://oZjEHmBMoOeaaM.eho9abmyifrTEBG8gBiQx9K5NepybIZg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ee9d98f-1575-438e-ace2-3fb27babac2d", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "hierarchies", ":hierarchy_id", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2cc1abba-3be5-4691-a39b-65df49e408b8", "name": "Get a Node's Products", "request": { "name": "Get a Node's Products", "description": { "content": "Returns the products associated with the specified hierarchy node in the catalog. The products must be in the `live` status. If the products have been curated, then the products are returned in the order specified in the `curated_products` attribute. A product that is curated has the `\"curated_product\": true` attribute displayed.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. See [Resolving catalog rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nYou can see the parent nodes a product is associated with in the `bread_crumbs` and `bread_crumb_nodes` metadata for each product. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\nThe `variations` object lists the variation IDs and variation option IDs and their corresponding product IDs that are generated when the variation and variation options are built with a product. The `variations` object can then be added to your catalogs. By default, variations and variation options are sorted randomly. You can use the `sort_order` attribute to sort the order of your variation and variation options in `variations`. Once a parent product is published in a catalog, the [Get a List of products in a catalog release](/docs/api/pxm/catalog/get-all-products) response displays the sorted variations and variation options. Variations and variation options are displayed in descending order according to their `sort_order` values.\n\n### Filtering\n\nThis endpoint supports filtering. For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available when filtering on this endpoint.\n\n| Operator | Description | Supported Attributes | Example |\n|:---|:------------------------------------------------------------------------------------------------|:---------------------------------------------------------|:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. For `product_types` and `tags`, you can only specify one. For example, `filter=eq(product_types,child)`. | `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. For `product_types` and `tags`, you can specify more than one. For example, `filter=in(product_types,child,bundle)`. | `id`, `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=in(id,some-id)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n\n### Including Resources\n\nUsing the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug. \n\n| Parameter | Required | Description |\n| :---------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n| `files` | Optional | Any files associated with a product. |\n\nSee [**Including Resources**](/guides/Getting-Started/includes).\n", "type": "text/plain" }, "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "nodes", ":node_id", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "node_id", "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "01a3cfc1-1bba-4894-b8f7-f6a4fcd76dc9", "name": "The products of a catalog node.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "nodes", ":node_id", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "node_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 7816\n },\n \"page\": {\n \"limit\": 9938,\n \"offset\": 2759,\n \"current\": 3857,\n \"total\": 8528\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7437,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 906,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 8590,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 8280,\n \"max\": 4438,\n \"sort_order\": 2552,\n \"options\": [\n {\n \"id\": \"61b67cf2-fe07-34be-6264-d708074a00c7\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8673,\n \"max\": 4691,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 4468,\n \"max\": 372,\n \"sort_order\": 6765,\n \"options\": [\n {\n \"id\": \"dad1dade-cde5-2d28-6636-40011309b2ab\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 4253,\n \"max\": 4813,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"min\": 9092,\n \"max\": 3207,\n \"sort_order\": 3349,\n \"options\": [\n {\n \"id\": \"8a96e778-da9e-171e-e0c8-3e2e7ac14ba2\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 6673,\n \"max\": 9572,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_3\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"9e2847d9-9fee-ee3e-d6b6-5f862246225e\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"cd595518-6f3c-8ddc-2160-168a949f2896\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"d70f2291-edfb-09d9-1a4b-d5424c826322\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"3fbcce08-7b2f-dc70-0088-4a0400ee39a0\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"949eb60b-3151-55b9-5a85-59fa828f0313\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"76df8064-b687-81ae-4389-0a6207318d21\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"key_1\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2281,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 602,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5442,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3389,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8594,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3047,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1933,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9942,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8372,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6466,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2035,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4614,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 884,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1063,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 831,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9680,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9852,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7182,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1700,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5728,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9236,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3352,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5317,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2798,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2617,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3714,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3410,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9279,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4730,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 498,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2078,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4873,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9320,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3640,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7604,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7834,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5130,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9310,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 94,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7453,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9512,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7192,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9289,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5967,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4427,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_3\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2948,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6436,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 312,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9765,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4485,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8613,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7079,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7152,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9169,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4336,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6877,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_4\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8492,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7277,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2062,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6232,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4753,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7600,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6722,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1567,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6885,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3865,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6384,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4037,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6849,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7322,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1857,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6271,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3544,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6677,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7729,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8195,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5624,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3380,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9324,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 459,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3205,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7535,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"98290a18-56fa-b336-0fe8-d0458638f88e\",\n \"name\": \"string\",\n \"sort_order\": 7685,\n \"option\": {\n \"id\": \"0d5ce731-10a0-b21f-15e5-ad36a5123722\",\n \"name\": \"string\",\n \"sort_order\": 5798,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"04b82f37-2401-4f42-7bdf-12d9c92ebe2c\",\n \"name\": \"string\",\n \"sort_order\": 9578,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"a267e97a-eab4-5a91-d312-5656b9d78054\",\n \"name\": \"string\",\n \"sort_order\": 3664,\n \"option\": {\n \"id\": \"eb12f1b2-8aac-71e5-3bcf-8f6685ead395\",\n \"name\": \"string\",\n \"sort_order\": 5622,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a7030cc1-9dfc-1462-9da1-05f16512a956\",\n \"name\": \"string\",\n \"sort_order\": 96,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7615,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 6845,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2422,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3570,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5840,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6553,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9815,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 724,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4997,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"included\": {\n \"main_images\": [\n {\n \"id\": \"e2c28b7e-d10e-6abb-4169-cd2482b03dfc\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ],\n \"component_products\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 2757,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5175,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 9406,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_3\": {\n \"minimum_quantity\": 5575,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 4553,\n \"max\": 5413,\n \"sort_order\": 2201,\n \"options\": [\n {\n \"id\": \"531186ce-3551-b846-bfa2-24d3fa804525\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8666,\n \"max\": 9305,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 6028,\n \"max\": 1133,\n \"sort_order\": 766,\n \"options\": [\n {\n \"id\": \"3af4bc55-dba0-1d41-c35a-0040411b6d62\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8867,\n \"max\": 5613,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"key_1\": {\n \"key_0\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"3c0577d5-5cb8-39d5-466e-b38d395a30c9\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"4616afd1-d81a-979b-ad01-e949628faa37\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"7fed1852-ea36-fa23-e8c2-a5761a4bcab8\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"aa66f582-8678-4585-4e71-a22fc4d82ae9\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"21d6dee3-1a4a-2d1f-218a-035b25557064\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"c88f5127-6b73-9195-d969-85e512db2c66\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4659,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3397,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 771,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4666,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9433,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1247,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8151,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8223,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1233,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1231,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8939,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5217,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5456,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7595,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9643,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3137,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 9752,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7647,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"a4c951fa-76e5-6426-1d40-7868ad13b38e\",\n \"name\": \"string\",\n \"sort_order\": 3161,\n \"option\": {\n \"id\": \"66a61f50-3514-0597-2b22-5e90ec32a9e7\",\n \"name\": \"string\",\n \"sort_order\": 7689,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"8a81f24d-eb2f-3e06-2457-7317697f2c15\",\n \"name\": \"string\",\n \"sort_order\": 6710,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"74ee4ab1-01cf-75fc-55c1-0d2a7977025e\",\n \"name\": \"string\",\n \"sort_order\": 8035,\n \"option\": {\n \"id\": \"d263aeca-6e19-2788-68b9-c3dd41aa1eb4\",\n \"name\": \"string\",\n \"sort_order\": 699,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a0fb8143-3b95-7104-5c5a-ad8c0505fe18\",\n \"name\": \"string\",\n \"sort_order\": 7985,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_3\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 501,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5604,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 513,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8460,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5511,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1817,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5851,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8316,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9126,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"files\": [\n {\n \"id\": \"eb7875b5-9133-e233-06a2-944cf6386a23\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"http://aXr.tkxnTbewPf-TSyfpFNdVQzKR1LZVqoG+w\",\n \"first\": \"http://tRHN.ltbMsPtrVEmTAVv+7aZVwEY+oQDiEB9NtHOnUy6ZMOxY6Wwc2pLRCx5NNA7dKxoFhu2rDnUpZCwPQyeZ3C\",\n \"last\": \"https://DqmxTwrhgHRhRldsRouVkU.tfiykl6c3SAC2MOs49EE6StQj8yJjQMWEuBpNfH7JLtUwjrO-uxzzRax4OHXYd,7M\",\n \"prev\": \"https://xlrXOmcnFODEXKWF.fkyum1CqXkuiTTF0Uvw7AJ.5ycueWt50Tr8EuPddYTDo-w1gg09+uw,hYD6-ujV\",\n \"next\": \"https://oZjEHmBMoOeaaM.eho9abmyifrTEBG8gBiQx9K5NepybIZg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0043620-1f67-4f61-965a-5147252e5586", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalogs", ":catalog_id", "releases", ":release_id", "nodes", ":node_id", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" }, { "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "node_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Shopper Catalog API", "description": "Use the Shopper Catalog View API to retrieve hierarchy, node and product information for a catalog release. When you publish a catalog for a store, you can define catalog rules so that you can show catalogs with different pricing or different products to preferred customers or channels. These endpoints can be used in your customer-facing frontends.\n\nA catalog is a combination of one or more hierarchies, products, and a price book. Use the Products API and Hierarchies API to create a hierarchy of products that can be included in a catalog. Use the Price Book API to associate prices with products.\n\n### Characteristics of Shopper Catalogs\n\nShopper catalogs can have the following characteristics.\n\n- Use catalog rules to schedule a catalog to appear during a particular date and time, such as a seasonal catalog. The catalog may have different pricing than the other catalogs. You can have multiple published catalogs.\n- If you have defined catalog rules and you want to retrieve a published catalog for a particular channel or a user-defined tag, you must set the appropriate headers in the request:\n - `EP-Channel` - The channel, such as website or mobile app. See [**Create a Catalog Rule**](/docs/api/pxm/catalog/create-rule).\n - `EP-Context-Tag` - A tag defined in the store, such as `clearance`. See [**Create a Catalog Rule**](/docs/api/pxm/catalog/create-rule).\n* When a catalog is ready to be used in a store, you publish it. See [**Publish a Catalog**](/docs/api/pxm/catalog/publish-release).\n* You can create and publish catalogs for different contexts and channels. You can see the differences between the last 2 consecutive catalog releases. See [**Publish a Catalog**](/docs/api/pxm/catalog/publish-release).\n* You retrieve catalogs for your shopper experience by using the Shopper Catalog View API. For more information on how you can retrieve a catalog as a shopper using the Catalog API.\n* When a catalog is published for a store, the corresponding events contain `store_id` and `org_id`. \n* When a catalog is published for an organization, the corresponding events contain `org_id`. \n* Use the `sort_order` value in `variations` to program your storefront to display the variation options in the order that you want.\n\n### Shopper Catalog Caching\n\nWhen conducting a `GET` on `catalog` endpoints, all data returned, including catalog releases, products, nodes and hierarchies, are cached for 5 minutes. This means, if you call the same endpoint again, the catalog data is retrieved from the cached objects pool, optimizing the performance and efficiency of your store front.\n\nIf you use any of the `catalog` endpoints with a `filter` or `include` query parameter, these are cached separately. \n\nThe cached entries disappear from the cached objects pool after 5 minutes.\n", "item": [ { "id": "ee23ca34-312b-4f41-a917-7de2b2dbbcac", "name": "Get all Hierarchies", "request": { "name": "Get all Hierarchies", "description": { "content": "Returns all hierarchies from a catalog.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\n| Operator | Description | Supported Attributes | Example |\n|:--- |:--- |:--- |:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. | `name`, `slug`| `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. | `id` | `filter=in(id,some-id)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n", "type": "text/plain" }, "url": { "path": [ "catalog", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "\nThis endpoints supports filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ef256259-4d32-4752-96db-1a2484a2ac11", "name": "The hierarchies of the catalog.", "originalRequest": { "url": { "path": [ "catalog", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "\nThis endpoints supports filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 2162\n },\n \"page\": {\n \"limit\": 1925,\n \"offset\": 5775,\n \"current\": 7170,\n \"total\": 7457\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"nodes\": {\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"hierarchy\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"nodes\": {\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"hierarchy\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n }\n ],\n \"links\": {\n \"self\": \"https://neOrRhGgbaUXnVPjNEHATtSy.htuvGQBBURTrvKOJwlxktH.Qy\",\n \"first\": \"https://wSHFFMlzTOIbSu.fvmYmDktf4n\",\n \"last\": \"http://qlLgAbHtsxZLhTPluoGnRWjyNj.jdSQu-Z0tN22pCv1lKek8mwRjyQnluXYQSrjjEpGoWQACDm2DV+f7-I\",\n \"prev\": \"https://DkyzXVrGlQcqSHkpiqvW.zwbmlwfbDPhTnHlNcg,DITA61+Cacq5PcUuKphJ.esy0\",\n \"next\": \"http://YIZditehdTFZElBtcbHwyOVNmEaOwyZxk.upQDFTjrbrawhcfu.fE\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1192184b-5294-4508-ab8f-d0b15c8ace38", "name": "An unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "\nThis endpoints supports filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1345241-3a00-499f-a914-00a652ea4a09", "name": "Get a Hierarchy", "request": { "name": "Get a Hierarchy", "description": { "content": "Returns a hierarchy from the catalog.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog to retrieve. For information about how catalog rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules).\n", "type": "text/plain" }, "url": { "path": [ "catalog", "hierarchies", ":hierarchy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "hierarchy_id", "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "63d692af-102f-4a00-8ca2-b02636e04bcb", "name": "The catalog hierarchy.", "originalRequest": { "url": { "path": [ "catalog", "hierarchies", ":hierarchy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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 \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"nodes\": {\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"hierarchy\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n \"links\": {\n \"self\": \"https://DMJfF.zuaIydyW5\",\n \"first\": \"https://pxqrGlHpWHnVNoXAIf.eum9vQ2sC93MDdczEHT\",\n \"last\": \"http://KuWjfUPXcveEdFUI.horrnOytb.hzWoN,nu0SO\",\n \"prev\": \"http://KDohTOythVYmmqCyRAzOjltkgLbDrA.cmmlKo7WawDjDzF\",\n \"next\": \"http://XKXELiQqFDnGwYmGhbS.uxbqp3Yv9kePn27s-M1mbbFpM.+VaBkLMYX2Q.JNgP8BG\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76afbecc-f23e-4747-8bab-dcd76413d621", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "hierarchies", ":hierarchy_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6bf2b5df-afdc-44b1-83b9-e93db8c7ca84", "name": "Get a Hierarchy's Nodes", "request": { "name": "Get a Hierarchy's Nodes", "description": { "content": "Returns all the nodes for the specified hierarchy.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nIn the `breadcrumbs` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\n| Operator | Description | Supported Attributes | Example |\n|:--- |:--- |:--- |:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. | `name`, `slug`| `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. | `id` | `filter=in(id,some-id)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n", "type": "text/plain" }, "url": { "path": [ "catalog", "hierarchies", ":hierarchy_id", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "hierarchy_id", "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2fa52ab5-c055-4006-b766-94f0fe549251", "name": "The child nodes of a catalog hierarchy.", "originalRequest": { "url": { "path": [ "catalog", "hierarchies", ":hierarchy_id", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 8983\n },\n \"page\": {\n \"limit\": 4298,\n \"offset\": 4318,\n \"current\": 1324,\n \"total\": 3299\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"b8e41b00-643d-ad5e-31b5-0477c57c1766\",\n \"type\": \"product\"\n },\n {\n \"id\": \"bbf36e7f-4dec-9f74-f797-0603753b0990\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"842c0629-3d2f-f057-ad7e-00898efe5f3f\",\n \"type\": \"product\"\n },\n {\n \"id\": \"b328d2d6-76b1-573a-05c8-54ba17cf79a8\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n }\n ],\n \"links\": {\n \"self\": \"https://YxDMYYIhWEosvoL.vjhDbr2HmbdeKZlIRf,Yv8V,mXvksH5TsgcItKMnggk1HLcOf20KX.N3iS\",\n \"first\": \"http://oVGoEFGPUXVPACqmvSTkCCuaBTCw.rrtD.n6DNhKxMvJelSUokuxcUWiGQPtJZHDaeO4vl3I.eAOS9de9wch\",\n \"last\": \"http://PcqFLAQBBiIWLklXxX.riVUBUI0kNHVVydfuYoT39w2WI\",\n \"prev\": \"https://y.tjMrk35P1p\",\n \"next\": \"http://gQliuCHkeysJIbrBmBfhlBNHpPmCHupLZ.hbRRvIlF,6Jdk.rg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0df94803-c511-40a5-9b7d-43fc11bf8186", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "hierarchies", ":hierarchy_id", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d556c261-ce72-4e9f-86eb-8be28a2f35ee", "name": "Get a Hierarchy's Children", "request": { "name": "Get a Hierarchy's Children", "description": { "content": "Returns the parent nodes for the specified hierarchy.\n\n![Parent Nodes](/assets/rootnodes.PNG)\n\nIf you have multiple catalog rules defined, the rule that best matches the shopperʼs context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nIn the `breadcrumbs` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\n### Filtering\n\nThe following operators and attributes are available when filtering on this endpoint.\n\n| Operator | Description | Supported Attributes | Example |\n|:--- |:--- |:--- |:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. | `name`, `slug`| `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. | `id` | `filter=in(id,some-id)` |\n\nFor more information, see [Filtering](/guides/Getting-Started/filtering).\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n", "type": "text/plain" }, "url": { "path": [ "catalog", "hierarchies", ":hierarchy_id", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "hierarchy_id", "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "49c48b1d-e202-40bf-aa97-e543bd239973", "name": "The child nodes of a catalog hierarchy.", "originalRequest": { "url": { "path": [ "catalog", "hierarchies", ":hierarchy_id", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 8983\n },\n \"page\": {\n \"limit\": 4298,\n \"offset\": 4318,\n \"current\": 1324,\n \"total\": 3299\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"b8e41b00-643d-ad5e-31b5-0477c57c1766\",\n \"type\": \"product\"\n },\n {\n \"id\": \"bbf36e7f-4dec-9f74-f797-0603753b0990\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"842c0629-3d2f-f057-ad7e-00898efe5f3f\",\n \"type\": \"product\"\n },\n {\n \"id\": \"b328d2d6-76b1-573a-05c8-54ba17cf79a8\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n }\n ],\n \"links\": {\n \"self\": \"https://YxDMYYIhWEosvoL.vjhDbr2HmbdeKZlIRf,Yv8V,mXvksH5TsgcItKMnggk1HLcOf20KX.N3iS\",\n \"first\": \"http://oVGoEFGPUXVPACqmvSTkCCuaBTCw.rrtD.n6DNhKxMvJelSUokuxcUWiGQPtJZHDaeO4vl3I.eAOS9de9wch\",\n \"last\": \"http://PcqFLAQBBiIWLklXxX.riVUBUI0kNHVVydfuYoT39w2WI\",\n \"prev\": \"https://y.tjMrk35P1p\",\n \"next\": \"http://gQliuCHkeysJIbrBmBfhlBNHpPmCHupLZ.hbRRvIlF,6Jdk.rg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "076c299b-4b0d-42ae-8a79-eeee96ca333f", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "hierarchies", ":hierarchy_id", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40b22783-a370-44d8-b106-d80f8b666476", "name": "Get all Nodes", "request": { "name": "Get all Nodes", "description": { "content": "Returns all nodes in the catalog.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nYou can see the parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\nIn a catalog, you can use a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. For more information, see [Building breadcrumbs in a storefront](#building-breadcrumbs-in-a-storefront).\n\nThe response lists the products associated with the nodes. If products are [curated](/guides/How-To/Products/curating-products), they are displayed in `curated_products`. Product curation allows you to promote specific products within each of your hierarchies, enabling you to create unique product collections in your storefront.\n\n- You can only curate 20 products or less. You cannot have more than 20 curated products.\n- If a curated product is removed from a node, the product is also removed from the `curated_products` list.\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available.\n\n| Operator | Description | Attributes | Example |\n| --- | --- | --- | --- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. | `name`, `slug` | `filter=eq(name,some-name)` |\n| `in` | Checks if the values are included in the specified string. If they are, the condition is true.\n| `Id` | `filter=in(id,9214719b-17fe-4ea7-896c-d61e60fc0d05,e104d541-2c52-47fa-8a9a-c4382480d97c,65daaf68-ff2e-4632-8944-370de835967d)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n", "type": "text/plain" }, "url": { "path": [ "catalog", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "da562eff-db17-4d5f-a6fd-059f27e76d9e", "name": "The nodes of the catalog.", "originalRequest": { "url": { "path": [ "catalog", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 8983\n },\n \"page\": {\n \"limit\": 4298,\n \"offset\": 4318,\n \"current\": 1324,\n \"total\": 3299\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"b8e41b00-643d-ad5e-31b5-0477c57c1766\",\n \"type\": \"product\"\n },\n {\n \"id\": \"bbf36e7f-4dec-9f74-f797-0603753b0990\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"842c0629-3d2f-f057-ad7e-00898efe5f3f\",\n \"type\": \"product\"\n },\n {\n \"id\": \"b328d2d6-76b1-573a-05c8-54ba17cf79a8\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n }\n ],\n \"links\": {\n \"self\": \"https://YxDMYYIhWEosvoL.vjhDbr2HmbdeKZlIRf,Yv8V,mXvksH5TsgcItKMnggk1HLcOf20KX.N3iS\",\n \"first\": \"http://oVGoEFGPUXVPACqmvSTkCCuaBTCw.rrtD.n6DNhKxMvJelSUokuxcUWiGQPtJZHDaeO4vl3I.eAOS9de9wch\",\n \"last\": \"http://PcqFLAQBBiIWLklXxX.riVUBUI0kNHVVydfuYoT39w2WI\",\n \"prev\": \"https://y.tjMrk35P1p\",\n \"next\": \"http://gQliuCHkeysJIbrBmBfhlBNHpPmCHupLZ.hbRRvIlF,6Jdk.rg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b5c3648-cab7-48cc-b04f-3f2035c74f14", "name": "An unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9aac195d-50e3-4fd7-9644-9e801a3b6d74", "name": "Get a Node", "request": { "name": "Get a Node", "description": { "content": "Returns a node from the catalog.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nYou can see the parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\nThe response lists the products associated with a node. If products are [curated](/guides/How-To/Products/curating-products), they are displayed in `curated_products`. Product curation allows you to promote specific products within each of your nodes, enabling you to create unique product collections in your storefront.\n\n- If you don't provide any `curated_products`, products are listed by their `updated_at` time in descending order, with the most recently updated product first.\n- If you configure `curated_products` for only a few products, the curated products are displayed first and the other products are displayed in the order of `updated_at` time.\n- You can only curate 20 products or less. You cannot have more than 20 curated products.\n- A product that is curated has the `\"curated_product\": true` attribute displayed.\n- If a curated product is removed from a node, the product is also removed from the `curated_products` list.\n", "type": "text/plain" }, "url": { "path": [ "catalog", "nodes", ":node_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "node_id", "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "537d10d7-608e-4e45-b9cb-b2800dfbf49c", "name": "The catalog node.", "originalRequest": { "url": { "path": [ "catalog", "nodes", ":node_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "node_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"693d4e46-3045-ea49-236e-300416befc4d\",\n \"type\": \"product\"\n },\n {\n \"id\": \"3767d926-965b-5009-45dd-a13597c74636\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n \"links\": {\n \"self\": \"http://ZeNrnffUUjESdbNGwRiZdhTzRw.wkwvn36vvnq2bpCMLkcK12uGwyKsKZDd.A,cfORDLbVufTkmXgQ+6fDkHX0-uNCDxQkMXRbqh\",\n \"first\": \"http://GAQgehZHViwliCTfbDOiMLHcWI.mvBihwMOGiuI1PvV6PRLtHFFHfW5\",\n \"last\": \"https://OuaQBNecxRrBmPDblBDf.vxxa6qsEpl24Df-Y\",\n \"prev\": \"http://RLfydyACYWuiHkZ.baHkNxYIPxRMzKyMgibOYuZdzy7fQKVZFM0sK6tK.wjnFdp6Hc7d\",\n \"next\": \"https://IXiFarPGluyGTMIFkYvLHWKgSfhQPuYs.itpLO-JuAoV+jSVVEXDez-kIPGFwf+CFXBIILc-Kdefwe\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7011ff8c-828c-43fd-93e4-aba8cf72ff26", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "nodes", ":node_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "node_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d33b4a61-d607-4b91-bbdb-afd9344dcd3d", "name": "Get a Node's Children", "request": { "name": "Get a Node's Children", "description": { "content": "Returns the child nodes for a node in the catalog.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nYou can see which parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\nThe response lists the products associated with the nodes. If products are [curated](/guides/How-To/Products/curating-products), they are displayed in `curated_products`. Product curation allows you to promote specific products within each of your hierarchies, enabling you to create unique product collections in your storefront.\n\n- If you don't provide any curated_products, products are listed by their updated_at time in descending order, with the most recently updated product first.\n- If you configure curated_products for only a few products, the curated products are displayed first and the other products are displayed in the order of updated_at time.\n- You can only curate 20 products or less. You cannot have more than 20 curated products.\n- A product that is curated has the \"curated_product\": true attribute displayed.\n- If a curated product is removed from a node, the product is also removed from the curated_products list.\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available.\n\n| Operator | Description | Attributes | Example |\n| --- | --- | --- | --- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. | `name`, `slug` | `filter=eq(name,some-name)` |\n| `in` | Checks if the values are included in the specified string. If they are, the condition is true.\n| `Id` | `filter=in(id,9214719b-17fe-4ea7-896c-d61e60fc0d05,e104d541-2c52-47fa-8a9a-c4382480d97c,65daaf68-ff2e-4632-8944-370de835967d)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n", "type": "text/plain" }, "url": { "path": [ "catalog", "nodes", ":node_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "node_id", "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "eca5ed4e-106a-461e-a5c8-13082f027743", "name": "The child nodes of a catalog node.", "originalRequest": { "url": { "path": [ "catalog", "nodes", ":node_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "node_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 8983\n },\n \"page\": {\n \"limit\": 4298,\n \"offset\": 4318,\n \"current\": 1324,\n \"total\": 3299\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"b8e41b00-643d-ad5e-31b5-0477c57c1766\",\n \"type\": \"product\"\n },\n {\n \"id\": \"bbf36e7f-4dec-9f74-f797-0603753b0990\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n },\n {\n \"attributes\": {\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"Formal dresswear\",\n \"label\": \"category\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\",\n \"curated_products\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"status\": \"live\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"updated_at\": \"1970-01-01T00:00:00.000\"\n },\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"relationships\": {\n \"products\": {\n \"data\": [\n {\n \"id\": \"842c0629-3d2f-f057-ad7e-00898efe5f3f\",\n \"type\": \"product\"\n },\n {\n \"id\": \"b328d2d6-76b1-573a-05c8-54ba17cf79a8\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"children\": {\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"node\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n },\n \"hierarchy\": {\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"hierarchy\"\n },\n \"links\": {\n \"related\": \"string\"\n }\n }\n },\n \"type\": \"node\",\n \"meta\": {\n \"language\": \"en-GB\",\n \"bread_crumb\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n },\n {\n \"id\": \"e871df93-c769-49a9-9394-a6fd555b8e8a\",\n \"name\": \"Formal dresswear\",\n \"slug\": \"formal\"\n }\n ],\n \"has_children\": true\n }\n }\n ],\n \"links\": {\n \"self\": \"https://YxDMYYIhWEosvoL.vjhDbr2HmbdeKZlIRf,Yv8V,mXvksH5TsgcItKMnggk1HLcOf20KX.N3iS\",\n \"first\": \"http://oVGoEFGPUXVPACqmvSTkCCuaBTCw.rrtD.n6DNhKxMvJelSUokuxcUWiGQPtJZHDaeO4vl3I.eAOS9de9wch\",\n \"last\": \"http://PcqFLAQBBiIWLklXxX.riVUBUI0kNHVVydfuYoT39w2WI\",\n \"prev\": \"https://y.tjMrk35P1p\",\n \"next\": \"http://gQliuCHkeysJIbrBmBfhlBNHpPmCHupLZ.hbRRvIlF,6Jdk.rg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8799de7-187f-4cde-b264-8c47ff5135a7", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "nodes", ":node_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering, see [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "node_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f931aef5-5119-485e-b07a-ac131935f682", "name": "Get all Products", "request": { "name": "Get all Products", "description": { "content": "Retrieves the list of products from the catalog. Only the products in a live status are retrieved.\n\n### Catalog Rules\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. If no catalog rules are configured, the first catalog found is returned. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\n### Product and Node Associations\n\n You can see the parent nodes a product is associated within the `bread_crumbs` and `bread_crumb_nodes` metadata for each product. For example, this is useful if you want to improve how your shoppers search your store. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\n### Including Resources\n\nUsing the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug. \n\n| Parameter | Required | Description |\n| :---------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n| `files` | Optional | Any files associated with a product. |\n\nSee [**Including Resources**](/guides/Getting-Started/includes).\n\n### Filtering\n\nThis endpoint supports filtering. For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available when filtering on this endpoint.\n\n| Operator | Description | Supported Attributes | Example |\n|:---|:------------------------------------------------------------------------------------------------|:---------------------------------------------------------|:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. For `product_types` and `tags`, you can only specify one. For example, `filter=eq(product_types,child)`. | `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. For `product_types` and `tags`, you can specify more than one. For example, `filter=in(product_types,child,bundle)`. | `id`, `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=in(id,some-id)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n", "type": "text/plain" }, "url": { "path": [ "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1ed938b2-f891-462f-90b7-334314a165f6", "name": "The products of a catalog.", "originalRequest": { "url": { "path": [ "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 7816\n },\n \"page\": {\n \"limit\": 9938,\n \"offset\": 2759,\n \"current\": 3857,\n \"total\": 8528\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7437,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 906,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 8590,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 8280,\n \"max\": 4438,\n \"sort_order\": 2552,\n \"options\": [\n {\n \"id\": \"61b67cf2-fe07-34be-6264-d708074a00c7\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8673,\n \"max\": 4691,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 4468,\n \"max\": 372,\n \"sort_order\": 6765,\n \"options\": [\n {\n \"id\": \"dad1dade-cde5-2d28-6636-40011309b2ab\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 4253,\n \"max\": 4813,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"min\": 9092,\n \"max\": 3207,\n \"sort_order\": 3349,\n \"options\": [\n {\n \"id\": \"8a96e778-da9e-171e-e0c8-3e2e7ac14ba2\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 6673,\n \"max\": 9572,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_3\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"9e2847d9-9fee-ee3e-d6b6-5f862246225e\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"cd595518-6f3c-8ddc-2160-168a949f2896\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"d70f2291-edfb-09d9-1a4b-d5424c826322\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"3fbcce08-7b2f-dc70-0088-4a0400ee39a0\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"949eb60b-3151-55b9-5a85-59fa828f0313\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"76df8064-b687-81ae-4389-0a6207318d21\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"key_1\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2281,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 602,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5442,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3389,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8594,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3047,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1933,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9942,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8372,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6466,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2035,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4614,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 884,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1063,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 831,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9680,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9852,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7182,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1700,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5728,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9236,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3352,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5317,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2798,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2617,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3714,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3410,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9279,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4730,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 498,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2078,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4873,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9320,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3640,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7604,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7834,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5130,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9310,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 94,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7453,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9512,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7192,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9289,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5967,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4427,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_3\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2948,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6436,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 312,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9765,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4485,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8613,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7079,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7152,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9169,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4336,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6877,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_4\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8492,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7277,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2062,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6232,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4753,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7600,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6722,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1567,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6885,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3865,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6384,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4037,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6849,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7322,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1857,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6271,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3544,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6677,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7729,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8195,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5624,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3380,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9324,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 459,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3205,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7535,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"98290a18-56fa-b336-0fe8-d0458638f88e\",\n \"name\": \"string\",\n \"sort_order\": 7685,\n \"option\": {\n \"id\": \"0d5ce731-10a0-b21f-15e5-ad36a5123722\",\n \"name\": \"string\",\n \"sort_order\": 5798,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"04b82f37-2401-4f42-7bdf-12d9c92ebe2c\",\n \"name\": \"string\",\n \"sort_order\": 9578,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"a267e97a-eab4-5a91-d312-5656b9d78054\",\n \"name\": \"string\",\n \"sort_order\": 3664,\n \"option\": {\n \"id\": \"eb12f1b2-8aac-71e5-3bcf-8f6685ead395\",\n \"name\": \"string\",\n \"sort_order\": 5622,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a7030cc1-9dfc-1462-9da1-05f16512a956\",\n \"name\": \"string\",\n \"sort_order\": 96,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7615,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 6845,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2422,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3570,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5840,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6553,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9815,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 724,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4997,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"included\": {\n \"main_images\": [\n {\n \"id\": \"e2c28b7e-d10e-6abb-4169-cd2482b03dfc\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ],\n \"component_products\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 2757,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5175,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 9406,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_3\": {\n \"minimum_quantity\": 5575,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 4553,\n \"max\": 5413,\n \"sort_order\": 2201,\n \"options\": [\n {\n \"id\": \"531186ce-3551-b846-bfa2-24d3fa804525\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8666,\n \"max\": 9305,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 6028,\n \"max\": 1133,\n \"sort_order\": 766,\n \"options\": [\n {\n \"id\": \"3af4bc55-dba0-1d41-c35a-0040411b6d62\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8867,\n \"max\": 5613,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"key_1\": {\n \"key_0\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"3c0577d5-5cb8-39d5-466e-b38d395a30c9\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"4616afd1-d81a-979b-ad01-e949628faa37\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"7fed1852-ea36-fa23-e8c2-a5761a4bcab8\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"aa66f582-8678-4585-4e71-a22fc4d82ae9\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"21d6dee3-1a4a-2d1f-218a-035b25557064\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"c88f5127-6b73-9195-d969-85e512db2c66\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4659,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3397,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 771,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4666,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9433,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1247,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8151,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8223,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1233,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1231,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8939,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5217,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5456,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7595,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9643,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3137,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 9752,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7647,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"a4c951fa-76e5-6426-1d40-7868ad13b38e\",\n \"name\": \"string\",\n \"sort_order\": 3161,\n \"option\": {\n \"id\": \"66a61f50-3514-0597-2b22-5e90ec32a9e7\",\n \"name\": \"string\",\n \"sort_order\": 7689,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"8a81f24d-eb2f-3e06-2457-7317697f2c15\",\n \"name\": \"string\",\n \"sort_order\": 6710,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"74ee4ab1-01cf-75fc-55c1-0d2a7977025e\",\n \"name\": \"string\",\n \"sort_order\": 8035,\n \"option\": {\n \"id\": \"d263aeca-6e19-2788-68b9-c3dd41aa1eb4\",\n \"name\": \"string\",\n \"sort_order\": 699,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a0fb8143-3b95-7104-5c5a-ad8c0505fe18\",\n \"name\": \"string\",\n \"sort_order\": 7985,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_3\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 501,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5604,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 513,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8460,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5511,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1817,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5851,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8316,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9126,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"files\": [\n {\n \"id\": \"eb7875b5-9133-e233-06a2-944cf6386a23\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"http://aXr.tkxnTbewPf-TSyfpFNdVQzKR1LZVqoG+w\",\n \"first\": \"http://tRHN.ltbMsPtrVEmTAVv+7aZVwEY+oQDiEB9NtHOnUy6ZMOxY6Wwc2pLRCx5NNA7dKxoFhu2rDnUpZCwPQyeZ3C\",\n \"last\": \"https://DqmxTwrhgHRhRldsRouVkU.tfiykl6c3SAC2MOs49EE6StQj8yJjQMWEuBpNfH7JLtUwjrO-uxzzRax4OHXYd,7M\",\n \"prev\": \"https://xlrXOmcnFODEXKWF.fkyum1CqXkuiTTF0Uvw7AJ.5ycueWt50Tr8EuPddYTDo-w1gg09+uw,hYD6-ujV\",\n \"next\": \"https://oZjEHmBMoOeaaM.eho9abmyifrTEBG8gBiQx9K5NepybIZg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ca64dc6-b016-40bc-a595-62fb24df0d03", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bad79b10-4dc6-4ebc-a0de-e70b59bed783", "name": "Get a Product", "request": { "name": "Get a Product", "description": { "content": "Returns the specified product from the catalog. The product must be in the `live` status.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nYou can see the parent nodes a product is associated with in the `bread_crumbs` and `bread_crumb_nodes` metadata for each product. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\nUsing the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug. \n\n| Parameter | Required | Description |\n| :---------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n| `files` | Optional | Any files associated with a product. |\n\nSee [**Including Resources**](/guides/Getting-Started/includes).\n", "type": "text/plain" }, "url": { "path": [ "catalog", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" } ], "variable": [ { "type": "any", "value": "string", "key": "product_id", "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "26ae22b9-2f9f-4e8e-b5b6-9cc63de6fb24", "name": "The product of a catalog.", "originalRequest": { "url": { "path": [ "catalog", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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 \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 6853,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 6663,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 9406,\n \"max\": 1125,\n \"sort_order\": 954,\n \"options\": [\n {\n \"id\": \"b7351151-061f-5c95-727e-944e01606adc\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 1842,\n \"max\": 1895,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 9234,\n \"max\": 7866,\n \"sort_order\": 237,\n \"options\": [\n {\n \"id\": \"347e7804-6e75-ec83-7e6d-2e88f1be96fe\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 7959,\n \"max\": 9678,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_3\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"key_1\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"a39becc8-b70b-1b2a-0090-5abe3bac60e8\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"f31fee2c-5b74-824c-1cba-fef1579b959c\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"05bd6ee7-7cd1-31a9-b336-0bf099cf77ce\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"9b236558-4a0c-b086-4d14-e5a29ee18af8\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"d9d662af-1997-c788-200b-9955f158259c\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"bf68ce53-021b-6147-45d7-4aeb8853be29\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8633,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6991,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5059,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5445,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 272,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7054,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3990,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2724,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8460,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9555,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2487,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7868,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1323,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3259,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3583,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7703,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9114,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6740,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4839,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4425,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 526,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6443,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1283,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4204,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5923,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1373,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1644,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2615,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6061,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3329,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3907,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1364,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9920,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1087,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8236,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2009,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6510,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7080,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7513,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9666,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"712b9df1-d4bd-42cd-b535-c8dfc49a5827\",\n \"name\": \"string\",\n \"sort_order\": 7061,\n \"option\": {\n \"id\": \"9f5a59aa-0842-d16f-0a05-4bb18765bbf9\",\n \"name\": \"string\",\n \"sort_order\": 7333,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"8403562a-9eaa-a139-7527-f47d9f45f1d5\",\n \"name\": \"string\",\n \"sort_order\": 9655,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"341e10e6-ff09-791f-c510-afff3ce38855\",\n \"name\": \"string\",\n \"sort_order\": 3357,\n \"option\": {\n \"id\": \"5344ead3-f3e6-e3ba-f3b1-b57d92b4451f\",\n \"name\": \"string\",\n \"sort_order\": 7687,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"cc2538a0-c57f-ed21-94e4-49681bcfeb86\",\n \"name\": \"string\",\n \"sort_order\": 4566,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5524,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 857,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3726,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6501,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4611,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4492,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4050,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 9720,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 696,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3527,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3125,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4262,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5308,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6532,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5430,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1779,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1092,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n },\n \"included\": {\n \"main_images\": [\n {\n \"id\": \"0c803ef4-fc47-d6c3-8bff-31523f576b68\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ],\n \"component_products\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 6826,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5333,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 7158,\n \"max\": 8863,\n \"sort_order\": 8611,\n \"options\": [\n {\n \"id\": \"d6d4ed14-82af-2478-d1aa-72a4a4a509ef\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 1775,\n \"max\": 1203,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 2614,\n \"max\": 6909,\n \"sort_order\": 6541,\n \"options\": [\n {\n \"id\": \"22d64e53-752b-3757-ab5e-d7d343b6b3e8\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 3588,\n \"max\": 6457,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"48f81978-ab05-815c-13f1-cf369700a2fc\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"539cb49f-156d-161d-c6ba-59667ec4a21d\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"a7d33abf-390f-22bf-44d2-da02abb9d654\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"25d51cc8-fd7e-3c80-a7b6-f0629221daf8\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"9759fbd0-af6e-8c28-077d-ef6a9045585a\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"9f304c63-90d4-e23f-3d2a-a566b272c717\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"key_1\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1915,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3150,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7748,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2794,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9454,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6890,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3114,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4813,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7026,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9105,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5076,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9026,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5633,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9587,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8222,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6925,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7159,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5370,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4991,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7038,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3287,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2277,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6870,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3266,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"80a92e9a-3c1c-8036-d382-a081a0df9267\",\n \"name\": \"string\",\n \"sort_order\": 8637,\n \"option\": {\n \"id\": \"9b7c86a3-87e2-b0fe-0e5d-6e50a98ff2ee\",\n \"name\": \"string\",\n \"sort_order\": 6052,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"1303e5d7-2893-1750-0232-f2fc53d86cf8\",\n \"name\": \"string\",\n \"sort_order\": 4035,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"5261e7ac-3210-47c3-c35c-08da7cb85ffc\",\n \"name\": \"string\",\n \"sort_order\": 6618,\n \"option\": {\n \"id\": \"59fc31d6-8726-8884-d485-c5bca11ea294\",\n \"name\": \"string\",\n \"sort_order\": 7785,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"9c566c3d-0137-3aed-999d-47773583050a\",\n \"name\": \"string\",\n \"sort_order\": 268,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5997,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7911,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6716,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4694,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2556,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2051,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6971,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1284,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8299,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 58,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6269,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3713,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8049,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"files\": [\n {\n \"id\": \"ae847ec3-4e7e-cbde-4b24-9c6303a03b0b\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"https://Wm.fgWRmWIJ8XWE2jtiD-HLffY3rT3xNLgnkM9ipCQ+0LVwH6C.SB,XsbyCAEHDbGSdB\",\n \"first\": \"https://vdRSUFSJk.lccsAVXA20Mh9JIB8WGF7xh7Wc1BbLpQ.+d\",\n \"last\": \"https://RYWRItdrAbDIPgRWnyGZaqpENRaXOsLW.zoAAC+9NFSXzPdv4,djR-UFNKu1JQPW,GxMDNXbbuJW.Y8RN7qz3i32izRxnxwAXrz\",\n \"prev\": \"https://CHamHQbMatK.jhqkX1yKF3fsNPJcxEMm-I2k-mitukoDnvx9awe9aRH4o6rppC\",\n \"next\": \"http://EgXGFFigWzhfFScVazdwaXPX.cyFj94G+-LMJQmMc.HVtUH40SZGjabFDw\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6ff9aa9-4993-4253-a0aa-1184e59a24d1", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "products", ":product_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20a8f10f-7a4a-4574-8104-a652e226b034", "name": "Get all Related Products of a Product", "request": { "name": "Get all Related Products of a Product", "description": { "content": "Returns related products of the provided product ID from a catalog.\n", "type": "text/plain" }, "url": { "path": [ "catalog", "products", ":product_id", "relationships", ":custom_relationship_slug", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "product_id", "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "custom_relationship_slug", "disabled": false, "description": { "content": "(Required) The custom relationship slug.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1f4ff43d-6272-4295-a821-04b3b738414d", "name": "The related products of a catalog.", "originalRequest": { "url": { "path": [ "catalog", "products", ":product_id", "relationships", ":custom_relationship_slug", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" }, { "disabled": false, "description": { "content": "(Required) The custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "string", "key": "custom_relationship_slug" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 7816\n },\n \"page\": {\n \"limit\": 9938,\n \"offset\": 2759,\n \"current\": 3857,\n \"total\": 8528\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7437,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 906,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 8590,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 8280,\n \"max\": 4438,\n \"sort_order\": 2552,\n \"options\": [\n {\n \"id\": \"61b67cf2-fe07-34be-6264-d708074a00c7\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8673,\n \"max\": 4691,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 4468,\n \"max\": 372,\n \"sort_order\": 6765,\n \"options\": [\n {\n \"id\": \"dad1dade-cde5-2d28-6636-40011309b2ab\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 4253,\n \"max\": 4813,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"min\": 9092,\n \"max\": 3207,\n \"sort_order\": 3349,\n \"options\": [\n {\n \"id\": \"8a96e778-da9e-171e-e0c8-3e2e7ac14ba2\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 6673,\n \"max\": 9572,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_3\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"9e2847d9-9fee-ee3e-d6b6-5f862246225e\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"cd595518-6f3c-8ddc-2160-168a949f2896\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"d70f2291-edfb-09d9-1a4b-d5424c826322\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"3fbcce08-7b2f-dc70-0088-4a0400ee39a0\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"949eb60b-3151-55b9-5a85-59fa828f0313\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"76df8064-b687-81ae-4389-0a6207318d21\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"key_1\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2281,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 602,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5442,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3389,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8594,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3047,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1933,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9942,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8372,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6466,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2035,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4614,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 884,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1063,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 831,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9680,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9852,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7182,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1700,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5728,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9236,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3352,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5317,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2798,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2617,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3714,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3410,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9279,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4730,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 498,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2078,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4873,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9320,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3640,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7604,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7834,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5130,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9310,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 94,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7453,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9512,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7192,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9289,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5967,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4427,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_3\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2948,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6436,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 312,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9765,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4485,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8613,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7079,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7152,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9169,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4336,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6877,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_4\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8492,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7277,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2062,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6232,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4753,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7600,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6722,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1567,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6885,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3865,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6384,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4037,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6849,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7322,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1857,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6271,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3544,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6677,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7729,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8195,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5624,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3380,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9324,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 459,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3205,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7535,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"98290a18-56fa-b336-0fe8-d0458638f88e\",\n \"name\": \"string\",\n \"sort_order\": 7685,\n \"option\": {\n \"id\": \"0d5ce731-10a0-b21f-15e5-ad36a5123722\",\n \"name\": \"string\",\n \"sort_order\": 5798,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"04b82f37-2401-4f42-7bdf-12d9c92ebe2c\",\n \"name\": \"string\",\n \"sort_order\": 9578,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"a267e97a-eab4-5a91-d312-5656b9d78054\",\n \"name\": \"string\",\n \"sort_order\": 3664,\n \"option\": {\n \"id\": \"eb12f1b2-8aac-71e5-3bcf-8f6685ead395\",\n \"name\": \"string\",\n \"sort_order\": 5622,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a7030cc1-9dfc-1462-9da1-05f16512a956\",\n \"name\": \"string\",\n \"sort_order\": 96,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7615,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 6845,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2422,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3570,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5840,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6553,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9815,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 724,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4997,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"included\": {\n \"main_images\": [\n {\n \"id\": \"e2c28b7e-d10e-6abb-4169-cd2482b03dfc\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ],\n \"component_products\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 2757,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5175,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 9406,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_3\": {\n \"minimum_quantity\": 5575,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 4553,\n \"max\": 5413,\n \"sort_order\": 2201,\n \"options\": [\n {\n \"id\": \"531186ce-3551-b846-bfa2-24d3fa804525\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8666,\n \"max\": 9305,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 6028,\n \"max\": 1133,\n \"sort_order\": 766,\n \"options\": [\n {\n \"id\": \"3af4bc55-dba0-1d41-c35a-0040411b6d62\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8867,\n \"max\": 5613,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"key_1\": {\n \"key_0\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"3c0577d5-5cb8-39d5-466e-b38d395a30c9\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"4616afd1-d81a-979b-ad01-e949628faa37\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"7fed1852-ea36-fa23-e8c2-a5761a4bcab8\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"aa66f582-8678-4585-4e71-a22fc4d82ae9\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"21d6dee3-1a4a-2d1f-218a-035b25557064\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"c88f5127-6b73-9195-d969-85e512db2c66\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4659,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3397,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 771,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4666,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9433,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1247,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8151,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8223,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1233,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1231,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8939,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5217,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5456,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7595,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9643,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3137,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 9752,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7647,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"a4c951fa-76e5-6426-1d40-7868ad13b38e\",\n \"name\": \"string\",\n \"sort_order\": 3161,\n \"option\": {\n \"id\": \"66a61f50-3514-0597-2b22-5e90ec32a9e7\",\n \"name\": \"string\",\n \"sort_order\": 7689,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"8a81f24d-eb2f-3e06-2457-7317697f2c15\",\n \"name\": \"string\",\n \"sort_order\": 6710,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"74ee4ab1-01cf-75fc-55c1-0d2a7977025e\",\n \"name\": \"string\",\n \"sort_order\": 8035,\n \"option\": {\n \"id\": \"d263aeca-6e19-2788-68b9-c3dd41aa1eb4\",\n \"name\": \"string\",\n \"sort_order\": 699,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a0fb8143-3b95-7104-5c5a-ad8c0505fe18\",\n \"name\": \"string\",\n \"sort_order\": 7985,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_3\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 501,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5604,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 513,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8460,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5511,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1817,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5851,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8316,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9126,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"files\": [\n {\n \"id\": \"eb7875b5-9133-e233-06a2-944cf6386a23\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"http://aXr.tkxnTbewPf-TSyfpFNdVQzKR1LZVqoG+w\",\n \"first\": \"http://tRHN.ltbMsPtrVEmTAVv+7aZVwEY+oQDiEB9NtHOnUy6ZMOxY6Wwc2pLRCx5NNA7dKxoFhu2rDnUpZCwPQyeZ3C\",\n \"last\": \"https://DqmxTwrhgHRhRldsRouVkU.tfiykl6c3SAC2MOs49EE6StQj8yJjQMWEuBpNfH7JLtUwjrO-uxzzRax4OHXYd,7M\",\n \"prev\": \"https://xlrXOmcnFODEXKWF.fkyum1CqXkuiTTF0Uvw7AJ.5ycueWt50Tr8EuPddYTDo-w1gg09+uw,hYD6-ujV\",\n \"next\": \"https://oZjEHmBMoOeaaM.eho9abmyifrTEBG8gBiQx9K5NepybIZg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4647072e-5d15-4035-a05b-a73f3584b8ed", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "products", ":product_id", "relationships", ":custom_relationship_slug", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" }, { "disabled": false, "description": { "content": "(Required) The custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "string", "key": "custom_relationship_slug" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b990025-b602-4a24-bed6-cb26e3205e02", "name": "Get a Bundle's Component Products", "request": { "name": "Get a Bundle's Component Products", "description": { "content": "With Product Experience Manager, you can [create](/docs/api/pxm/products/create-product) and manage bundles. A bundle is a purchasable product, comprising of one or more products that you want to sell together. \n\nYou can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity.\n\nThis endpoint returns a list of component product IDs for the specified bundle.\n", "type": "text/plain" }, "url": { "path": [ "catalog", "products", ":product_id", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "product_id", "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ad751718-1c4a-402e-9c54-900b73032293", "name": "The list of component product IDs of a bundle product from a catalog.", "originalRequest": { "url": { "path": [ "catalog", "products", ":product_id", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 5732\n },\n \"page\": {\n \"limit\": 5381,\n \"offset\": 2712,\n \"current\": 1973,\n \"total\": 2778\n }\n },\n \"data\": [\n {\n \"id\": \"be1166ed-7aec-0652-d239-775554db95c7\",\n \"type\": \"product\"\n },\n {\n \"id\": \"11b5c1cf-fc7c-a6ca-ba70-1cf13078d19e\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"http://HDEKtwXFNCbDKnocl.ultEf0lMRnmFDn794BVRmtOBhioqcI7sNG2kKXT,NwOpv4PoNaMqmpKANUTXyW.+86SirDVcx-J\",\n \"first\": \"https://bMJuhuHMlFYQzPtlkgOPOnZJejcYT.oanHVUajWDy\",\n \"last\": \"https://nLxjAsbWanlfemHVBCEVhQEPwKYWAG.nyFDPRk5GcVyLy-hMqkOwHoDEjtcTq\",\n \"prev\": \"http://FOnuoefFrASQIfyQJ.umdqyGLLdUisH84GY-UmcCuN7Ed,BOSWEmZC5cBPa5XjGl9zH51gxjfBR-6eIVUo\",\n \"next\": \"http://bbx.ateSg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8caae4e3-f848-4a48-8382-05f06fd6ae95", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "products", ":product_id", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bdcc5834-f2c9-4c2d-9837-cd289c5b0319", "name": "Get a Parent Product's Child Products", "request": { "name": "Get a Parent Product's Child Products", "description": { "content": "For a specified product and catalog release, retrieves a list of child products from a parent product. Any product other than a base product results in a `422 Unprocessable Entity` response. Only the products in a `live` status are retrieved.\n\nIf you have multiple catalog rules defined, the rule that best matches the shopperʼs context is used to determine which catalog is retrieved. If no catalog rules are configured, the first catalog found is returned. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nYou can see the parent nodes a product is associated within the `breadcrumbs` metadata for each product. For example, this is useful if you want to improve how your shoppers search your store. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\n### Filtering\n\nThis endpoint supports filtering. For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available when filtering on this endpoint.\n\n| Operator | Description | Supported Attributes | Example |\n|:---|:------------------------------------------------------------------------------------------------|:---------------------------------------------------------|:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. For `product_types` and `tags`, you can only specify one. For example, `filter=eq(product_types,child)`. | `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. For `product_types` and `tags`, you can specify more than one. For example, `filter=in(product_types,child,bundle)`. | `id`, `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=in(id,some-id)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n\n### Including Resources\n\nUsing the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug. \n\n| Parameter | Required | Description |\n| :---------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n| `files` | Optional | Any files associated with a product. |\n\nSee [**Including Resources**](/guides/Getting-Started/includes).\n", "type": "text/plain" }, "url": { "path": [ "catalog", "products", ":product_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "product_id", "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9a31874a-ee3e-4699-b666-6f130c5061e0", "name": "The list of child products of a parent product from a catalog.", "originalRequest": { "url": { "path": [ "catalog", "products", ":product_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 7816\n },\n \"page\": {\n \"limit\": 9938,\n \"offset\": 2759,\n \"current\": 3857,\n \"total\": 8528\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7437,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 906,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 8590,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 8280,\n \"max\": 4438,\n \"sort_order\": 2552,\n \"options\": [\n {\n \"id\": \"61b67cf2-fe07-34be-6264-d708074a00c7\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8673,\n \"max\": 4691,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 4468,\n \"max\": 372,\n \"sort_order\": 6765,\n \"options\": [\n {\n \"id\": \"dad1dade-cde5-2d28-6636-40011309b2ab\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 4253,\n \"max\": 4813,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"min\": 9092,\n \"max\": 3207,\n \"sort_order\": 3349,\n \"options\": [\n {\n \"id\": \"8a96e778-da9e-171e-e0c8-3e2e7ac14ba2\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 6673,\n \"max\": 9572,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_3\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"9e2847d9-9fee-ee3e-d6b6-5f862246225e\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"cd595518-6f3c-8ddc-2160-168a949f2896\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"d70f2291-edfb-09d9-1a4b-d5424c826322\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"3fbcce08-7b2f-dc70-0088-4a0400ee39a0\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"949eb60b-3151-55b9-5a85-59fa828f0313\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"76df8064-b687-81ae-4389-0a6207318d21\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"key_1\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2281,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 602,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5442,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3389,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8594,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3047,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1933,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9942,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8372,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6466,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2035,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4614,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 884,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1063,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 831,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9680,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9852,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7182,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1700,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5728,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9236,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3352,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5317,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2798,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2617,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3714,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3410,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9279,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4730,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 498,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2078,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4873,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9320,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3640,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7604,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7834,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5130,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9310,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 94,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7453,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9512,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7192,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9289,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5967,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4427,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_3\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2948,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6436,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 312,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9765,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4485,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8613,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7079,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7152,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9169,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4336,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6877,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_4\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8492,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7277,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2062,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6232,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4753,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7600,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6722,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1567,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6885,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3865,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6384,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4037,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6849,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7322,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1857,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6271,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3544,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6677,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7729,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8195,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5624,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3380,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9324,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 459,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3205,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7535,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"98290a18-56fa-b336-0fe8-d0458638f88e\",\n \"name\": \"string\",\n \"sort_order\": 7685,\n \"option\": {\n \"id\": \"0d5ce731-10a0-b21f-15e5-ad36a5123722\",\n \"name\": \"string\",\n \"sort_order\": 5798,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"04b82f37-2401-4f42-7bdf-12d9c92ebe2c\",\n \"name\": \"string\",\n \"sort_order\": 9578,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"a267e97a-eab4-5a91-d312-5656b9d78054\",\n \"name\": \"string\",\n \"sort_order\": 3664,\n \"option\": {\n \"id\": \"eb12f1b2-8aac-71e5-3bcf-8f6685ead395\",\n \"name\": \"string\",\n \"sort_order\": 5622,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a7030cc1-9dfc-1462-9da1-05f16512a956\",\n \"name\": \"string\",\n \"sort_order\": 96,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7615,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 6845,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2422,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3570,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5840,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6553,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9815,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 724,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4997,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"included\": {\n \"main_images\": [\n {\n \"id\": \"e2c28b7e-d10e-6abb-4169-cd2482b03dfc\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ],\n \"component_products\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 2757,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5175,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 9406,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_3\": {\n \"minimum_quantity\": 5575,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 4553,\n \"max\": 5413,\n \"sort_order\": 2201,\n \"options\": [\n {\n \"id\": \"531186ce-3551-b846-bfa2-24d3fa804525\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8666,\n \"max\": 9305,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 6028,\n \"max\": 1133,\n \"sort_order\": 766,\n \"options\": [\n {\n \"id\": \"3af4bc55-dba0-1d41-c35a-0040411b6d62\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8867,\n \"max\": 5613,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"key_1\": {\n \"key_0\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"3c0577d5-5cb8-39d5-466e-b38d395a30c9\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"4616afd1-d81a-979b-ad01-e949628faa37\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"7fed1852-ea36-fa23-e8c2-a5761a4bcab8\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"aa66f582-8678-4585-4e71-a22fc4d82ae9\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"21d6dee3-1a4a-2d1f-218a-035b25557064\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"c88f5127-6b73-9195-d969-85e512db2c66\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4659,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3397,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 771,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4666,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9433,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1247,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8151,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8223,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1233,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1231,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8939,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5217,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5456,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7595,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9643,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3137,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 9752,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7647,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"a4c951fa-76e5-6426-1d40-7868ad13b38e\",\n \"name\": \"string\",\n \"sort_order\": 3161,\n \"option\": {\n \"id\": \"66a61f50-3514-0597-2b22-5e90ec32a9e7\",\n \"name\": \"string\",\n \"sort_order\": 7689,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"8a81f24d-eb2f-3e06-2457-7317697f2c15\",\n \"name\": \"string\",\n \"sort_order\": 6710,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"74ee4ab1-01cf-75fc-55c1-0d2a7977025e\",\n \"name\": \"string\",\n \"sort_order\": 8035,\n \"option\": {\n \"id\": \"d263aeca-6e19-2788-68b9-c3dd41aa1eb4\",\n \"name\": \"string\",\n \"sort_order\": 699,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a0fb8143-3b95-7104-5c5a-ad8c0505fe18\",\n \"name\": \"string\",\n \"sort_order\": 7985,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_3\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 501,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5604,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 513,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8460,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5511,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1817,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5851,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8316,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9126,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"files\": [\n {\n \"id\": \"eb7875b5-9133-e233-06a2-944cf6386a23\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"http://aXr.tkxnTbewPf-TSyfpFNdVQzKR1LZVqoG+w\",\n \"first\": \"http://tRHN.ltbMsPtrVEmTAVv+7aZVwEY+oQDiEB9NtHOnUy6ZMOxY6Wwc2pLRCx5NNA7dKxoFhu2rDnUpZCwPQyeZ3C\",\n \"last\": \"https://DqmxTwrhgHRhRldsRouVkU.tfiykl6c3SAC2MOs49EE6StQj8yJjQMWEuBpNfH7JLtUwjrO-uxzzRax4OHXYd,7M\",\n \"prev\": \"https://xlrXOmcnFODEXKWF.fkyum1CqXkuiTTF0Uvw7AJ.5ycueWt50Tr8EuPddYTDo-w1gg09+uw,hYD6-ujV\",\n \"next\": \"https://oZjEHmBMoOeaaM.eho9abmyifrTEBG8gBiQx9K5NepybIZg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86e2bc09-6714-43f7-bd15-62df70a73abe", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "products", ":product_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "64844371-8e25-4ddc-8408-0e4f3a2ed20f", "name": "Get a Hierarchy's Products", "request": { "name": "Get a Hierarchy's Products", "description": { "content": "Returns the products associated with the specified hierarchy in the catalog. The products must be in the live status.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. See [Resolving catalog rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nYou can see the parent nodes a product is associated with in the `bread_crumbs` and `bread_crumb_nodes` metadata for each product. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\n### Filtering\n\nThis endpoint supports filtering. For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available when filtering on this endpoint.\n\n| Operator | Description | Supported Attributes | Example |\n|:---|:------------------------------------------------------------------------------------------------|:---------------------------------------------------------|:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. For `product_types` and `tags`, you can only specify one. For example, `filter=eq(product_types,child)`. | `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. For `product_types` and `tags`, you can specify more than one. For example, `filter=in(product_types,child,bundle)`. | `id`, `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=in(id,some-id)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n\n### Including Resources\n\nUsing the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug. \n\n| Parameter | Required | Description |\n| :---------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n `files` | Optional | Any files associated with a product. |\n\nSee [**Including Resources**](/guides/Getting-Started/includes).\n", "type": "text/plain" }, "url": { "path": [ "catalog", "hierarchies", ":hierarchy_id", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "hierarchy_id", "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "19125e62-0227-4382-838d-129e6e4f6ceb", "name": "The products of a catalog hierarchy.", "originalRequest": { "url": { "path": [ "catalog", "hierarchies", ":hierarchy_id", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 7816\n },\n \"page\": {\n \"limit\": 9938,\n \"offset\": 2759,\n \"current\": 3857,\n \"total\": 8528\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7437,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 906,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 8590,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 8280,\n \"max\": 4438,\n \"sort_order\": 2552,\n \"options\": [\n {\n \"id\": \"61b67cf2-fe07-34be-6264-d708074a00c7\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8673,\n \"max\": 4691,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 4468,\n \"max\": 372,\n \"sort_order\": 6765,\n \"options\": [\n {\n \"id\": \"dad1dade-cde5-2d28-6636-40011309b2ab\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 4253,\n \"max\": 4813,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"min\": 9092,\n \"max\": 3207,\n \"sort_order\": 3349,\n \"options\": [\n {\n \"id\": \"8a96e778-da9e-171e-e0c8-3e2e7ac14ba2\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 6673,\n \"max\": 9572,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_3\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"9e2847d9-9fee-ee3e-d6b6-5f862246225e\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"cd595518-6f3c-8ddc-2160-168a949f2896\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"d70f2291-edfb-09d9-1a4b-d5424c826322\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"3fbcce08-7b2f-dc70-0088-4a0400ee39a0\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"949eb60b-3151-55b9-5a85-59fa828f0313\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"76df8064-b687-81ae-4389-0a6207318d21\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"key_1\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2281,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 602,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5442,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3389,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8594,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3047,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1933,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9942,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8372,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6466,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2035,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4614,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 884,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1063,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 831,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9680,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9852,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7182,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1700,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5728,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9236,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3352,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5317,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2798,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2617,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3714,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3410,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9279,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4730,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 498,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2078,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4873,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9320,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3640,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7604,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7834,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5130,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9310,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 94,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7453,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9512,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7192,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9289,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5967,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4427,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_3\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2948,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6436,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 312,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9765,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4485,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8613,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7079,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7152,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9169,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4336,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6877,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_4\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8492,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7277,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2062,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6232,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4753,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7600,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6722,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1567,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6885,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3865,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6384,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4037,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6849,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7322,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1857,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6271,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3544,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6677,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7729,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8195,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5624,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3380,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9324,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 459,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3205,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7535,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"98290a18-56fa-b336-0fe8-d0458638f88e\",\n \"name\": \"string\",\n \"sort_order\": 7685,\n \"option\": {\n \"id\": \"0d5ce731-10a0-b21f-15e5-ad36a5123722\",\n \"name\": \"string\",\n \"sort_order\": 5798,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"04b82f37-2401-4f42-7bdf-12d9c92ebe2c\",\n \"name\": \"string\",\n \"sort_order\": 9578,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"a267e97a-eab4-5a91-d312-5656b9d78054\",\n \"name\": \"string\",\n \"sort_order\": 3664,\n \"option\": {\n \"id\": \"eb12f1b2-8aac-71e5-3bcf-8f6685ead395\",\n \"name\": \"string\",\n \"sort_order\": 5622,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a7030cc1-9dfc-1462-9da1-05f16512a956\",\n \"name\": \"string\",\n \"sort_order\": 96,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7615,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 6845,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2422,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3570,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5840,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6553,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9815,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 724,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4997,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"included\": {\n \"main_images\": [\n {\n \"id\": \"e2c28b7e-d10e-6abb-4169-cd2482b03dfc\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ],\n \"component_products\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 2757,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5175,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 9406,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_3\": {\n \"minimum_quantity\": 5575,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 4553,\n \"max\": 5413,\n \"sort_order\": 2201,\n \"options\": [\n {\n \"id\": \"531186ce-3551-b846-bfa2-24d3fa804525\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8666,\n \"max\": 9305,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 6028,\n \"max\": 1133,\n \"sort_order\": 766,\n \"options\": [\n {\n \"id\": \"3af4bc55-dba0-1d41-c35a-0040411b6d62\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8867,\n \"max\": 5613,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"key_1\": {\n \"key_0\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"3c0577d5-5cb8-39d5-466e-b38d395a30c9\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"4616afd1-d81a-979b-ad01-e949628faa37\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"7fed1852-ea36-fa23-e8c2-a5761a4bcab8\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"aa66f582-8678-4585-4e71-a22fc4d82ae9\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"21d6dee3-1a4a-2d1f-218a-035b25557064\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"c88f5127-6b73-9195-d969-85e512db2c66\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4659,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3397,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 771,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4666,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9433,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1247,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8151,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8223,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1233,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1231,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8939,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5217,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5456,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7595,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9643,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3137,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 9752,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7647,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"a4c951fa-76e5-6426-1d40-7868ad13b38e\",\n \"name\": \"string\",\n \"sort_order\": 3161,\n \"option\": {\n \"id\": \"66a61f50-3514-0597-2b22-5e90ec32a9e7\",\n \"name\": \"string\",\n \"sort_order\": 7689,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"8a81f24d-eb2f-3e06-2457-7317697f2c15\",\n \"name\": \"string\",\n \"sort_order\": 6710,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"74ee4ab1-01cf-75fc-55c1-0d2a7977025e\",\n \"name\": \"string\",\n \"sort_order\": 8035,\n \"option\": {\n \"id\": \"d263aeca-6e19-2788-68b9-c3dd41aa1eb4\",\n \"name\": \"string\",\n \"sort_order\": 699,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a0fb8143-3b95-7104-5c5a-ad8c0505fe18\",\n \"name\": \"string\",\n \"sort_order\": 7985,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_3\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 501,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5604,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 513,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8460,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5511,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1817,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5851,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8316,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9126,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"files\": [\n {\n \"id\": \"eb7875b5-9133-e233-06a2-944cf6386a23\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"http://aXr.tkxnTbewPf-TSyfpFNdVQzKR1LZVqoG+w\",\n \"first\": \"http://tRHN.ltbMsPtrVEmTAVv+7aZVwEY+oQDiEB9NtHOnUy6ZMOxY6Wwc2pLRCx5NNA7dKxoFhu2rDnUpZCwPQyeZ3C\",\n \"last\": \"https://DqmxTwrhgHRhRldsRouVkU.tfiykl6c3SAC2MOs49EE6StQj8yJjQMWEuBpNfH7JLtUwjrO-uxzzRax4OHXYd,7M\",\n \"prev\": \"https://xlrXOmcnFODEXKWF.fkyum1CqXkuiTTF0Uvw7AJ.5ycueWt50Tr8EuPddYTDo-w1gg09+uw,hYD6-ujV\",\n \"next\": \"https://oZjEHmBMoOeaaM.eho9abmyifrTEBG8gBiQx9K5NepybIZg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60715d89-5586-4c7a-aec6-50329f7d9912", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "hierarchies", ":hierarchy_id", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog hierarchy ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "hierarchy_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8752e90-9232-4c7b-ae3b-2ac972677af1", "name": "Get a Node's Products", "request": { "name": "Get a Node's Products", "description": { "content": "Returns the products associated with the specified hierarchy node in the catalog. The products must be in the `live` status. If the products have been curated then the products are returned in the order specified in the `curated_products` attribute. A product that is curated has the `\"curated_product\": true` attribute displayed.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. See [Resolving catalog rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nYou can see the parent nodes a product is associated with in the `bread_crumbs` and `bread_crumb_nodes` metadata for each product. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\n### Filtering\n\nThis endpoint supports filtering. For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available when filtering on this endpoint.\n\n| Operator | Description | Supported Attributes | Example |\n|:---|:------------------------------------------------------------------------------------------------|:---------------------------------------------------------|:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. For `product_types` and `tags`, you can only specify one. For example, `filter=eq(product_types,child)`. | `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=eq(name,some-name)` |\n| `In` | Checks if the values are included in the specified string. If they are, the condition is true. For `product_types` and `tags`, you can specify more than one. For example, `filter=in(product_types,child,bundle)`. | `id`, `name`, `sku`, `slug`, `manufacturer_part_num`, `upc_ean`, `product_types`, `tags` | `filter=in(id,some-id)` |\n\n### Building breadcrumbs in a storefront\n\nIn a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in `breadcrumbs` metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.\n\nAn example is shown below:\n\n`filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)`\n\n- Specify the node IDs directly attached to the product in the filter expression.\n- You can include as many node IDs as required.\n- It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.\n\n### Including Resources\n\nUsing the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug.\n\n| Parameter | Required | Description |\n| :---------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n| `files` | Optional | Any files associated with a product. |\n\nSee [**Including Resources**](/guides/Getting-Started/includes).\n", "type": "text/plain" }, "url": { "path": [ "catalog", "nodes", ":node_id", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "type": "any", "value": "string", "key": "node_id", "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4f2f0023-42f8-4354-bb7a-1ed7beffb194", "name": "The products of a catalog node.", "originalRequest": { "url": { "path": [ "catalog", "nodes", ":node_id", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "node_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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 \"meta\": {\n \"results\": {\n \"total\": 7816\n },\n \"page\": {\n \"limit\": 9938,\n \"offset\": 2759,\n \"current\": 3857,\n \"total\": 8528\n }\n },\n \"data\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7437,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 906,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 8590,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 8280,\n \"max\": 4438,\n \"sort_order\": 2552,\n \"options\": [\n {\n \"id\": \"61b67cf2-fe07-34be-6264-d708074a00c7\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8673,\n \"max\": 4691,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 4468,\n \"max\": 372,\n \"sort_order\": 6765,\n \"options\": [\n {\n \"id\": \"dad1dade-cde5-2d28-6636-40011309b2ab\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 4253,\n \"max\": 4813,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"min\": 9092,\n \"max\": 3207,\n \"sort_order\": 3349,\n \"options\": [\n {\n \"id\": \"8a96e778-da9e-171e-e0c8-3e2e7ac14ba2\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 6673,\n \"max\": 9572,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_3\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"9e2847d9-9fee-ee3e-d6b6-5f862246225e\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"cd595518-6f3c-8ddc-2160-168a949f2896\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"d70f2291-edfb-09d9-1a4b-d5424c826322\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"3fbcce08-7b2f-dc70-0088-4a0400ee39a0\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"949eb60b-3151-55b9-5a85-59fa828f0313\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"76df8064-b687-81ae-4389-0a6207318d21\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"key_1\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2281,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 602,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5442,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3389,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8594,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3047,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1933,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9942,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8372,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6466,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2035,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4614,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 884,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1063,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 831,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9680,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9852,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7182,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1700,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5728,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9236,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3352,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5317,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2798,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2617,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3714,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3410,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9279,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4816,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4730,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 498,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2078,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4873,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9320,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3640,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7604,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7834,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5130,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9310,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 94,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7453,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9512,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7192,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9289,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5967,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4427,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_3\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2948,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6436,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 312,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9765,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4485,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8613,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7079,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7152,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9169,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4336,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6877,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_4\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8492,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7277,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2062,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6232,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4753,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7600,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6722,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1567,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6885,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3865,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6384,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4037,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6849,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7322,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1857,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6271,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3544,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6677,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7729,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8195,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5624,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 419,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3380,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9324,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 459,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3205,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7535,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"98290a18-56fa-b336-0fe8-d0458638f88e\",\n \"name\": \"string\",\n \"sort_order\": 7685,\n \"option\": {\n \"id\": \"0d5ce731-10a0-b21f-15e5-ad36a5123722\",\n \"name\": \"string\",\n \"sort_order\": 5798,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"04b82f37-2401-4f42-7bdf-12d9c92ebe2c\",\n \"name\": \"string\",\n \"sort_order\": 9578,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"a267e97a-eab4-5a91-d312-5656b9d78054\",\n \"name\": \"string\",\n \"sort_order\": 3664,\n \"option\": {\n \"id\": \"eb12f1b2-8aac-71e5-3bcf-8f6685ead395\",\n \"name\": \"string\",\n \"sort_order\": 5622,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a7030cc1-9dfc-1462-9da1-05f16512a956\",\n \"name\": \"string\",\n \"sort_order\": 96,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 7615,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 6845,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2422,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3570,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5840,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6553,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9524,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9815,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 724,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4997,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"included\": {\n \"main_images\": [\n {\n \"id\": \"e2c28b7e-d10e-6abb-4169-cd2482b03dfc\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ],\n \"component_products\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 2757,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5175,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_2\": {\n \"minimum_quantity\": 9406,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_3\": {\n \"minimum_quantity\": 5575,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 4553,\n \"max\": 5413,\n \"sort_order\": 2201,\n \"options\": [\n {\n \"id\": \"531186ce-3551-b846-bfa2-24d3fa804525\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8666,\n \"max\": 9305,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 6028,\n \"max\": 1133,\n \"sort_order\": 766,\n \"options\": [\n {\n \"id\": \"3af4bc55-dba0-1d41-c35a-0040411b6d62\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 8867,\n \"max\": 5613,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n },\n \"key_1\": {\n \"key_0\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"3c0577d5-5cb8-39d5-466e-b38d395a30c9\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"4616afd1-d81a-979b-ad01-e949628faa37\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"7fed1852-ea36-fa23-e8c2-a5761a4bcab8\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"aa66f582-8678-4585-4e71-a22fc4d82ae9\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"21d6dee3-1a4a-2d1f-218a-035b25557064\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"c88f5127-6b73-9195-d969-85e512db2c66\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4659,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3397,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 771,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4666,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9433,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1247,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8151,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8223,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1233,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1231,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8939,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5217,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5456,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7595,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9643,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4107,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3137,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 9752,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7647,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"a4c951fa-76e5-6426-1d40-7868ad13b38e\",\n \"name\": \"string\",\n \"sort_order\": 3161,\n \"option\": {\n \"id\": \"66a61f50-3514-0597-2b22-5e90ec32a9e7\",\n \"name\": \"string\",\n \"sort_order\": 7689,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"8a81f24d-eb2f-3e06-2457-7317697f2c15\",\n \"name\": \"string\",\n \"sort_order\": 6710,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"74ee4ab1-01cf-75fc-55c1-0d2a7977025e\",\n \"name\": \"string\",\n \"sort_order\": 8035,\n \"option\": {\n \"id\": \"d263aeca-6e19-2788-68b9-c3dd41aa1eb4\",\n \"name\": \"string\",\n \"sort_order\": 699,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"a0fb8143-3b95-7104-5c5a-ad8c0505fe18\",\n \"name\": \"string\",\n \"sort_order\": 7985,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_3\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_4\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_2\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 501,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5604,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 513,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8460,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3591,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5511,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1817,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5851,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8316,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9126,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"files\": [\n {\n \"id\": \"eb7875b5-9133-e233-06a2-944cf6386a23\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"http://aXr.tkxnTbewPf-TSyfpFNdVQzKR1LZVqoG+w\",\n \"first\": \"http://tRHN.ltbMsPtrVEmTAVv+7aZVwEY+oQDiEB9NtHOnUy6ZMOxY6Wwc2pLRCx5NNA7dKxoFhu2rDnUpZCwPQyeZ3C\",\n \"last\": \"https://DqmxTwrhgHRhRldsRouVkU.tfiykl6c3SAC2MOs49EE6StQj8yJjQMWEuBpNfH7JLtUwjrO-uxzzRax4OHXYd,7M\",\n \"prev\": \"https://xlrXOmcnFODEXKWF.fkyum1CqXkuiTTF0Uvw7AJ.5ycueWt50Tr8EuPddYTDo-w1gg09+uw,hYD6-ujV\",\n \"next\": \"https://oZjEHmBMoOeaaM.eho9abmyifrTEBG8gBiQx9K5NepybIZg\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1f37600-6a13-45e2-bc20-d9f5fedf8e0c", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "nodes", ":node_id", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" }, { "disabled": false, "description": { "content": "This endpoints support filtering. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "1378" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.", "type": "text/plain" }, "key": "page[offset]", "value": "9007" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The catalog node ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "node_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19cf0f64-e50a-45b4-ab06-502887450f98", "name": "Configure a Shopper Bundle", "request": { "name": "Configure a Shopper Bundle", "description": { "content": "Once you have configured your product bundles, you can display them in your storefront in your published catalog. Depending on how you have configured the minimum and maximum values for the product options in your components, you can allow your shoppers to choose which products they want to select. For example, you can enable a shopper to select 1 or more product options from a list of 10, giving your shoppers greater flexibility when selecting products in your store front.\n\n- Products must be in a `live` status.\n- If you have not specified any minimum or maximum values for the product options in your components, your shoppers can select any combination of product options.\n\nIf you have configured minimum and maximum values using [Create a Bundle](/docs/api/pxm/products/create-product), this becomes part of the `bundle_configuration`. You can check how your bundle is configured using [Get a product in a catalog release](/docs/api/pxm/catalog/get-product) in `bundle_configuration` under `meta`. The `bundle_configuration` forms the body of the request.\n\nThe response updates the `bundle_configuration` with the product options the shopper selects. The `meta` data is updated with the `meta` data of the selected product options. In your storefront, you could display this as a summary of the product options a shopper has selected.\n\n### Including Resources\n\nUsing the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug. \n\n| Parameter | Required | Description |\n| :---------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n| `files` | Optional | Any files associated with a product. |\n\nSee [**Including Resources**](/guides/Getting-Started/includes).\n", "type": "text/plain" }, "url": { "path": [ "catalog", "products", ":product_id", "configure" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" } ], "variable": [ { "type": "any", "value": "string", "key": "product_id", "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "30d10f81-cb3f-4e4d-99ce-14bb0eeac740", "name": "The configured product of a catalog.", "originalRequest": { "url": { "path": [ "catalog", "products", ":product_id", "configure" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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 \"data\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\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 \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 6853,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 6663,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 9406,\n \"max\": 1125,\n \"sort_order\": 954,\n \"options\": [\n {\n \"id\": \"b7351151-061f-5c95-727e-944e01606adc\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 1842,\n \"max\": 1895,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 9234,\n \"max\": 7866,\n \"sort_order\": 237,\n \"options\": [\n {\n \"id\": \"347e7804-6e75-ec83-7e6d-2e88f1be96fe\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 7959,\n \"max\": 9678,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_2\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_3\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {},\n \"key_1\": {}\n },\n \"key_1\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"a39becc8-b70b-1b2a-0090-5abe3bac60e8\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"f31fee2c-5b74-824c-1cba-fef1579b959c\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"05bd6ee7-7cd1-31a9-b336-0bf099cf77ce\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"9b236558-4a0c-b086-4d14-e5a29ee18af8\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"d9d662af-1997-c788-200b-9955f158259c\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"bf68ce53-021b-6147-45d7-4aeb8853be29\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8633,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6991,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5059,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5445,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 272,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7054,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3990,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2724,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8460,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9555,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 2487,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7868,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1323,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3259,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3583,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7703,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9114,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6740,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4839,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4425,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 526,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6443,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1283,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4204,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5923,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1373,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1644,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2615,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6061,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3329,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3907,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1364,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9920,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1087,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8236,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2009,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6510,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7080,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7513,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9666,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"712b9df1-d4bd-42cd-b535-c8dfc49a5827\",\n \"name\": \"string\",\n \"sort_order\": 7061,\n \"option\": {\n \"id\": \"9f5a59aa-0842-d16f-0a05-4bb18765bbf9\",\n \"name\": \"string\",\n \"sort_order\": 7333,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"8403562a-9eaa-a139-7527-f47d9f45f1d5\",\n \"name\": \"string\",\n \"sort_order\": 9655,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"341e10e6-ff09-791f-c510-afff3ce38855\",\n \"name\": \"string\",\n \"sort_order\": 3357,\n \"option\": {\n \"id\": \"5344ead3-f3e6-e3ba-f3b1-b57d92b4451f\",\n \"name\": \"string\",\n \"sort_order\": 7687,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"cc2538a0-c57f-ed21-94e4-49681bcfeb86\",\n \"name\": \"string\",\n \"sort_order\": 4566,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5524,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 857,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3726,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6501,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4611,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4492,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 4050,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 9720,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 696,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3527,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3125,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4262,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5308,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_2\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6532,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5430,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1779,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 1092,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n },\n \"included\": {\n \"main_images\": [\n {\n \"id\": \"0c803ef4-fc47-d6c3-8bff-31523f576b68\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ],\n \"component_products\": [\n {\n \"attributes\": {\n \"published_at\": \"1970-01-01T00:00:00.000\",\n \"base_product\": false,\n \"base_product_id\": \"cdf574bc-e36e-48fc-9eac-01c87839b285\",\n \"commodity_type\": \"physical\",\n \"curated_product\": true,\n \"upc_ean\": \"0123456\",\n \"manufacturer_part_num\": \"mfn1\",\n \"tags\": [\n \"tag-a\"\n ],\n \"price_modifiers\": [\n \"modifier-1\"\n ],\n \"created_at\": \"1970-01-01T00:00:00.000\",\n \"description\": \"This is a product\",\n \"name\": \"Blue shirt\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 6826,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"minimum_quantity\": 5333,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"min\": 7158,\n \"max\": 8863,\n \"sort_order\": 8611,\n \"options\": [\n {\n \"id\": \"d6d4ed14-82af-2478-d1aa-72a4a4a509ef\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 1775,\n \"max\": 1203,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"min\": 2614,\n \"max\": 6909,\n \"sort_order\": 6541,\n \"options\": [\n {\n \"id\": \"22d64e53-752b-3757-ab5e-d7d343b6b3e8\",\n \"type\": \"product\",\n \"quantity\": 2,\n \"min\": 3588,\n \"max\": 6457,\n \"sort_order\": 15,\n \"default\": true,\n \"product_should_be_substituted_with_child\": true,\n \"excluded_children\": [\n \"2d491d1c-729d-43d7-a2d2-e0a56edab43d\"\n ]\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n },\n \"key_1\": {\n \"name\": \"Message\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 255\n }\n }\n ],\n \"required\": false\n }\n },\n \"sku\": \"blue-shirt\",\n \"slug\": \"blue-shirt\",\n \"status\": \"live\",\n \"external_ref\": \"string\",\n \"updated_at\": \"1970-01-01T00:00:00.000\",\n \"extensions\": {\n \"key_0\": {\n \"key_0\": {}\n }\n }\n },\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"48f81978-ab05-815c-13f1-cf369700a2fc\",\n \"type\": \"product\"\n }\n },\n \"children\": {\n \"data\": [\n {\n \"id\": \"539cb49f-156d-161d-c6ba-59667ec4a21d\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"files\": {\n \"data\": [\n {\n \"type\": \"file\",\n \"id\": \"a7d33abf-390f-22bf-44d2-da02abb9d654\",\n \"created_at\": \"1970-01-01T00:00:00.000\"\n }\n ]\n },\n \"main_image\": {\n \"data\": {\n \"type\": \"main_image\",\n \"id\": \"25d51cc8-fd7e-3c80-a7b6-f0629221daf8\"\n }\n },\n \"component_products\": {\n \"data\": [\n {\n \"id\": \"9759fbd0-af6e-8c28-077d-ef6a9045585a\",\n \"type\": \"product\"\n }\n ],\n \"links\": {\n \"self\": \"string\"\n }\n },\n \"custom_relationships\": {\n \"data\": [\n {\n \"id\": \"9f304c63-90d4-e23f-3d2a-a566b272c717\",\n \"type\": \"product\"\n }\n ],\n \"links\": {}\n }\n },\n \"type\": \"product\",\n \"meta\": {\n \"bread_crumbs\": {\n \"key_0\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"key_1\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ]\n },\n \"bread_crumb_nodes\": [\n \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\"\n ],\n \"catalog_id\": \"362a16dc-f7c6-4280-83d6-4fcc152af091\",\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 1915,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3150,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"catalog_source\": \"pim\",\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 7748,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2794,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n },\n \"component_products\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9454,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6890,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3114,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 4813,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"pricebook_id\": \"f5466169-0037-460c-b181-b02682b6f4de\",\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7026,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9105,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 5076,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9026,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_3\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5633,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 9587,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 8222,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6925,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7159,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 5370,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4991,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 7038,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ]\n }\n },\n \"component_product_data\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"price_modifiers\": {\n \"key_0\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n },\n \"key_1\": {\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3287,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2277,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 6870,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 3266,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n },\n \"variation_matrix\": {},\n \"variations\": [\n {\n \"id\": \"80a92e9a-3c1c-8036-d382-a081a0df9267\",\n \"name\": \"string\",\n \"sort_order\": 8637,\n \"option\": {\n \"id\": \"9b7c86a3-87e2-b0fe-0e5d-6e50a98ff2ee\",\n \"name\": \"string\",\n \"sort_order\": 6052,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"1303e5d7-2893-1750-0232-f2fc53d86cf8\",\n \"name\": \"string\",\n \"sort_order\": 4035,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"child_option_ids\": [\n \"string\"\n ],\n \"child_variations\": [\n {\n \"id\": \"5261e7ac-3210-47c3-c35c-08da7cb85ffc\",\n \"name\": \"string\",\n \"sort_order\": 6618,\n \"option\": {\n \"id\": \"59fc31d6-8726-8884-d485-c5bca11ea294\",\n \"name\": \"string\",\n \"sort_order\": 7785,\n \"description\": \"string\"\n },\n \"options\": [\n {\n \"id\": \"9c566c3d-0137-3aed-999d-47773583050a\",\n \"name\": \"string\",\n \"sort_order\": 268,\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"product_types\": [\n \"string\"\n ],\n \"language\": \"en-GB\",\n \"custom_relationships\": [\n \"string\"\n ],\n \"available_prices\": [\n {\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\"\n },\n \"sales\": {\n \"key_0\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n },\n \"key_1\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n },\n \"key_1\": {\n \"schedule\": {\n \"valid_from\": \"2020-09-22T09:00:00\",\n \"valid_to\": \"2020-09-22T09:00:00\"\n },\n \"currencies\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5,\n \"amount\": 100\n }\n }\n }\n }\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"minimum_quantity\": 5997,\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n }\n }\n }\n }\n ],\n \"alternative_prices\": [\n {\n \"name\": \"string\",\n \"pricebook_id\": \"string\",\n \"shopper_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"sale_id\": \"string\",\n \"sale_expires\": \"2025-07-07T14:30:00Z\",\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 7911,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6716,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 4694,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 2556,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"tiers\": {\n \"key_0\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 2051,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6971,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 1284,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8299,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n },\n \"key_1\": {\n \"original_price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"price\": {\n \"key_0\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_1\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"key_2\": {\n \"amount\": 100,\n \"includes_tax\": false\n }\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 58,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 6269,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n },\n \"original_display_price\": {\n \"with_tax\": {\n \"amount\": 3713,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n },\n \"without_tax\": {\n \"amount\": 8049,\n \"currency\": \"USD\",\n \"formatted\": \"$475.00\",\n \"float_price\": 475\n }\n }\n }\n }\n }\n ],\n \"available_pricebook_ids\": [\n \"string\"\n ]\n }\n }\n ],\n \"files\": [\n {\n \"id\": \"ae847ec3-4e7e-cbde-4b24-9c6303a03b0b\",\n \"type\": \"file\",\n \"file_name\": \"file_name.jpg\",\n \"mime_type\": \"image/jpeg\",\n \"file_size\": 36000,\n \"public\": true,\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-10-11T13:02:25.293Z\"\n },\n \"dimensions\": {\n \"width\": 1800,\n \"height\": 1000\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52\"\n },\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\",\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"self\": \"https://Wm.fgWRmWIJ8XWE2jtiD-HLffY3rT3xNLgnkM9ipCQ+0LVwH6C.SB,XsbyCAEHDbGSdB\",\n \"first\": \"https://vdRSUFSJk.lccsAVXA20Mh9JIB8WGF7xh7Wc1BbLpQ.+d\",\n \"last\": \"https://RYWRItdrAbDIPgRWnyGZaqpENRaXOsLW.zoAAC+9NFSXzPdv4,djR-UFNKu1JQPW,GxMDNXbbuJW.Y8RN7qz3i32izRxnxwAXrz\",\n \"prev\": \"https://CHamHQbMatK.jhqkX1yKF3fsNPJcxEMm-I2k-mitukoDnvx9awe9aRH4o6rppC\",\n \"next\": \"http://EgXGFFigWzhfFScVazdwaXPX.cyFj94G+-LMJQmMc.HVtUH40SZGjabFDw\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dbf1019-900a-4638-a66e-bc5fce1c15e7", "name": "The unexpected error.", "originalRequest": { "url": { "path": [ "catalog", "products", ":product_id", "configure" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,files" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The product ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "product_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "string" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "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 \"data\": {\n \"selected_options\": {\n \"games\": {\n \"p292e1db-c919-4d2f-984a-c2ddc79df024\": 2\n },\n \"consoles\": {\n \"759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a\": 1\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n },\n {\n \"detail\": \"not processable\",\n \"status\": \"422\",\n \"title\": \"There was a problem processing your request.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Search", "description": "The Search API enables you to search for products in your published catalogs. Search provides powerful capabilities including full-text search, filtering, faceting, and sorting to help shoppers find products quickly and efficiently.\n\n### How Search Works\n\nWhen you publish a catalog with search enabled, the catalog's products are automatically indexed for search. The search index contains product data optimized for fast querying, including product names, descriptions, SKUs, categories, prices, and any custom fields you've configured.\n\nThere are two types of search operations:\n\n- **Search**: Execute a single search query against a catalog. Use the GET endpoint for simple searches with query parameters.\n- **Multi-search**: Execute multiple search queries in a single request. Use the POST endpoint to batch searches together for improved performance.\n\n### Search Features\n\n- **Full-text search**: Search across product names, descriptions, SKUs, and custom fields with typo tolerance and relevance ranking\n- **Filtering**: Narrow results using conditions on product attributes, categories, prices, and custom fields\n- **Faceting**: Get aggregated counts for attribute values to build dynamic navigation and refinement options\n- **Sorting**: Order results by price, name, custom fields, or relevance score\n- **Highlighting**: Get highlighted snippets showing where search terms match in product fields\n- **Autocomplete**: Get search suggestions as shoppers type their queries\n\n### Shopper Context\n\nSearch results are personalized based on the shopper's context. The system automatically determines which catalog and prices to use based on:\n\n- **Channel**: The shopping experience (web, mobile, B2B portal)\n- **Account**: For B2B scenarios, the account and parent accounts\n- **Customer**: The logged-in customer's segment\n- **Tags**: Custom context tags for advanced segmentation\n\nThis context is provided via request headers and is used to resolve the appropriate catalog rules and price books.\n\n### Admin vs Shopper Endpoints\n\n- **Shopper endpoints** (`/pcm/catalog/search`, `/pcm/catalog/multi-search`): Use shopper context headers to automatically resolve the correct catalog and prices.\n- **Admin endpoints** (`/pcm/catalogs/{catalog_id}/releases/{release_id}/search`): Directly specify the catalog and release to search, useful for previewing releases or testing.\n", "item": [ { "id": "0eb572f1-113d-464d-9395-5fa8f5f20da2", "name": "Multi-search", "request": { "name": "Multi-search", "description": { "content": "Execute one or more searches in a single request.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalog", "multi-search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"searches\": [\n {\n \"type\": \"search\",\n \"highlight_full_fields\": \"name,description\",\n \"q\": \"search query\",\n \"facet_by\": \"meta.search.nodes.name\",\n \"filter_by\": \"meta.search.nodes.name:=Electronics && price.float_price:>=10.00\",\n \"sort_by\": \"price.amount:asc,extensions.products(Specification).rating:desc\",\n \"max_facet_values\": 10,\n \"page\": 1,\n \"per_page\": 20\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5468545c-386d-4ecc-967e-8d15c35c885a", "name": "Multi-search results", "originalRequest": { "url": { "path": [ "pcm", "catalog", "multi-search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "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 \"searches\": [\n {\n \"type\": \"search\",\n \"highlight_full_fields\": \"name,description\",\n \"q\": \"search query\",\n \"facet_by\": \"meta.search.nodes.name\",\n \"filter_by\": \"meta.search.nodes.name:=Electronics && price.float_price:>=10.00\",\n \"sort_by\": \"price.amount:asc,extensions.products(Specification).rating:desc\",\n \"max_facet_values\": 10,\n \"page\": 1,\n \"per_page\": 20\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"type\": \"search\",\n \"facet_counts\": [\n {\n \"counts\": [\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n },\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n }\n ],\n \"field_name\": \"category\",\n \"sampled\": false,\n \"stats\": {}\n },\n {\n \"counts\": [\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n },\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n }\n ],\n \"field_name\": \"category\",\n \"sampled\": false,\n \"stats\": {}\n }\n ],\n \"found\": 150,\n \"hits\": [\n {\n \"document\": {\n \"attributes\": {},\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {},\n \"type\": \"product\",\n \"meta\": {}\n },\n \"highlight\": {}\n },\n {\n \"document\": {\n \"attributes\": {},\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {},\n \"type\": \"product\",\n \"meta\": {}\n },\n \"highlight\": {}\n }\n ],\n \"out_of\": 150,\n \"page\": 1,\n \"request_params\": {},\n \"search_cutoff\": false,\n \"search_time_ms\": 25\n },\n {\n \"type\": \"search\",\n \"facet_counts\": [\n {\n \"counts\": [\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n },\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n }\n ],\n \"field_name\": \"category\",\n \"sampled\": false,\n \"stats\": {}\n },\n {\n \"counts\": [\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n },\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n }\n ],\n \"field_name\": \"category\",\n \"sampled\": false,\n \"stats\": {}\n }\n ],\n \"found\": 150,\n \"hits\": [\n {\n \"document\": {\n \"attributes\": {},\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {},\n \"type\": \"product\",\n \"meta\": {}\n },\n \"highlight\": {}\n },\n {\n \"document\": {\n \"attributes\": {},\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {},\n \"type\": \"product\",\n \"meta\": {}\n },\n \"highlight\": {}\n }\n ],\n \"out_of\": 150,\n \"page\": 1,\n \"request_params\": {},\n \"search_cutoff\": false,\n \"search_time_ms\": 25\n }\n ],\n \"included\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "093a55d2-4655-47a2-bfba-579a0690bd39", "name": "Bad request - invalid search parameters", "originalRequest": { "url": { "path": [ "pcm", "catalog", "multi-search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "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 \"searches\": [\n {\n \"type\": \"search\",\n \"highlight_full_fields\": \"name,description\",\n \"q\": \"search query\",\n \"facet_by\": \"meta.search.nodes.name\",\n \"filter_by\": \"meta.search.nodes.name:=Electronics && price.float_price:>=10.00\",\n \"sort_by\": \"price.amount:asc,extensions.products(Specification).rating:desc\",\n \"max_facet_values\": 10,\n \"page\": 1,\n \"per_page\": 20\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Invalid Filter\",\n \"status\": \"400\",\n \"detail\": \"Could not parse the filter query.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ffbad5c-bcb1-4050-860d-3fcfa51ab056", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalog", "multi-search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "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 \"searches\": [\n {\n \"type\": \"search\",\n \"highlight_full_fields\": \"name,description\",\n \"q\": \"search query\",\n \"facet_by\": \"meta.search.nodes.name\",\n \"filter_by\": \"meta.search.nodes.name:=Electronics && price.float_price:>=10.00\",\n \"sort_by\": \"price.amount:asc,extensions.products(Specification).rating:desc\",\n \"max_facet_values\": 10,\n \"page\": 1,\n \"per_page\": 20\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e4c3cbc-e6b1-432b-a08e-cb30ce31fe1f", "name": "Admin Multi-search", "request": { "name": "Admin Multi-search", "description": { "content": "Execute one or more searches in a single request.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", ":catalog_id", "releases", ":release_id", "multi-search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The ID of the catalog to query", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique ID of a published release of the catalog or `latestPublished` for the most recently published version", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"searches\": [\n {\n \"type\": \"search\",\n \"highlight_full_fields\": \"name,description\",\n \"q\": \"search query\",\n \"facet_by\": \"meta.search.nodes.name\",\n \"filter_by\": \"meta.search.nodes.name:=Electronics && price.float_price:>=10.00\",\n \"sort_by\": \"price.amount:asc,extensions.products(Specification).rating:desc\",\n \"max_facet_values\": 10,\n \"page\": 1,\n \"per_page\": 20\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5a5cf7eb-ccf0-4c81-90c0-685633a3c6f4", "name": "Multi-search results", "originalRequest": { "url": { "path": [ "pcm", "catalogs", ":catalog_id", "releases", ":release_id", "multi-search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the catalog to query", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique ID of a published release of the catalog or `latestPublished` for the most recently published version", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "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 \"searches\": [\n {\n \"type\": \"search\",\n \"highlight_full_fields\": \"name,description\",\n \"q\": \"search query\",\n \"facet_by\": \"meta.search.nodes.name\",\n \"filter_by\": \"meta.search.nodes.name:=Electronics && price.float_price:>=10.00\",\n \"sort_by\": \"price.amount:asc,extensions.products(Specification).rating:desc\",\n \"max_facet_values\": 10,\n \"page\": 1,\n \"per_page\": 20\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"type\": \"search\",\n \"facet_counts\": [\n {\n \"counts\": [\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n },\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n }\n ],\n \"field_name\": \"category\",\n \"sampled\": false,\n \"stats\": {}\n },\n {\n \"counts\": [\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n },\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n }\n ],\n \"field_name\": \"category\",\n \"sampled\": false,\n \"stats\": {}\n }\n ],\n \"found\": 150,\n \"hits\": [\n {\n \"document\": {\n \"attributes\": {},\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {},\n \"type\": \"product\",\n \"meta\": {}\n },\n \"highlight\": {}\n },\n {\n \"document\": {\n \"attributes\": {},\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {},\n \"type\": \"product\",\n \"meta\": {}\n },\n \"highlight\": {}\n }\n ],\n \"out_of\": 150,\n \"page\": 1,\n \"request_params\": {},\n \"search_cutoff\": false,\n \"search_time_ms\": 25\n },\n {\n \"type\": \"search\",\n \"facet_counts\": [\n {\n \"counts\": [\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n },\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n }\n ],\n \"field_name\": \"category\",\n \"sampled\": false,\n \"stats\": {}\n },\n {\n \"counts\": [\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n },\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n }\n ],\n \"field_name\": \"category\",\n \"sampled\": false,\n \"stats\": {}\n }\n ],\n \"found\": 150,\n \"hits\": [\n {\n \"document\": {\n \"attributes\": {},\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {},\n \"type\": \"product\",\n \"meta\": {}\n },\n \"highlight\": {}\n },\n {\n \"document\": {\n \"attributes\": {},\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {},\n \"type\": \"product\",\n \"meta\": {}\n },\n \"highlight\": {}\n }\n ],\n \"out_of\": 150,\n \"page\": 1,\n \"request_params\": {},\n \"search_cutoff\": false,\n \"search_time_ms\": 25\n }\n ],\n \"included\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2844707f-79ad-46b9-9d6a-56667a64531d", "name": "Bad request - invalid search parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", ":catalog_id", "releases", ":release_id", "multi-search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the catalog to query", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique ID of a published release of the catalog or `latestPublished` for the most recently published version", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "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 \"searches\": [\n {\n \"type\": \"search\",\n \"highlight_full_fields\": \"name,description\",\n \"q\": \"search query\",\n \"facet_by\": \"meta.search.nodes.name\",\n \"filter_by\": \"meta.search.nodes.name:=Electronics && price.float_price:>=10.00\",\n \"sort_by\": \"price.amount:asc,extensions.products(Specification).rating:desc\",\n \"max_facet_values\": 10,\n \"page\": 1,\n \"per_page\": 20\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Invalid Filter\",\n \"status\": \"400\",\n \"detail\": \"Could not parse the filter query.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb45d815-c207-4bbe-a7a0-35066918c36a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", ":catalog_id", "releases", ":release_id", "multi-search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the catalog to query", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique ID of a published release of the catalog or `latestPublished` for the most recently published version", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "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 \"searches\": [\n {\n \"type\": \"search\",\n \"highlight_full_fields\": \"name,description\",\n \"q\": \"search query\",\n \"facet_by\": \"meta.search.nodes.name\",\n \"filter_by\": \"meta.search.nodes.name:=Electronics && price.float_price:>=10.00\",\n \"sort_by\": \"price.amount:asc,extensions.products(Specification).rating:desc\",\n \"max_facet_values\": 10,\n \"page\": 1,\n \"per_page\": 20\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f5b9a7a-253b-4455-98fb-57e014ba2486", "name": "Search", "request": { "name": "Search", "description": { "content": "Execute search.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalog", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" }, { "disabled": false, "description": { "content": "Type of search operation to perform (This can only be one of search,autocomplete)", "type": "text/plain" }, "key": "type", "value": "search" }, { "disabled": false, "description": { "content": "Comma-separated list of fields to highlight", "type": "text/plain" }, "key": "highlight_full_fields", "value": "name,description" }, { "disabled": false, "description": { "content": "(Required) Search query", "type": "text/plain" }, "key": "q", "value": "search query" }, { "disabled": false, "description": { "content": "Specifies which fields to use for generating facets in search results. See [faceting](/guides/How-To/Catalogs/Search/faceting) for more details.", "type": "text/plain" }, "key": "facet_by", "value": "meta.search.nodes.name" }, { "disabled": false, "description": { "content": "Applies conditions to narrow down search results based on specific field values. See [filtering](/guides/How-To/Catalogs/Search/filtering) for more details.", "type": "text/plain" }, "key": "filter_by", "value": "meta.search.nodes.name:=Electronics && price.float_price:>=10.00" }, { "disabled": false, "description": { "content": "Orders search results by specified fields. See [sorting](/guides/How-To/Catalogs/Search/sorting) for more details.", "type": "text/plain" }, "key": "sort_by", "value": "price.amount:asc,extensions.products(Specification).rating:desc" }, { "disabled": false, "description": { "content": "Maximum number of facet values to return", "type": "text/plain" }, "key": "max_facet_values", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4c0c35d7-7f5a-45ed-aba3-bf6c515cba74", "name": "Search results", "originalRequest": { "url": { "path": [ "pcm", "catalog", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" }, { "disabled": false, "description": { "content": "Type of search operation to perform (This can only be one of search,autocomplete)", "type": "text/plain" }, "key": "type", "value": "search" }, { "disabled": false, "description": { "content": "Comma-separated list of fields to highlight", "type": "text/plain" }, "key": "highlight_full_fields", "value": "name,description" }, { "disabled": false, "description": { "content": "(Required) Search query", "type": "text/plain" }, "key": "q", "value": "search query" }, { "disabled": false, "description": { "content": "Specifies which fields to use for generating facets in search results. See [faceting](/guides/How-To/Catalogs/Search/faceting) for more details.", "type": "text/plain" }, "key": "facet_by", "value": "meta.search.nodes.name" }, { "disabled": false, "description": { "content": "Applies conditions to narrow down search results based on specific field values. See [filtering](/guides/How-To/Catalogs/Search/filtering) for more details.", "type": "text/plain" }, "key": "filter_by", "value": "meta.search.nodes.name:=Electronics && price.float_price:>=10.00" }, { "disabled": false, "description": { "content": "Orders search results by specified fields. See [sorting](/guides/How-To/Catalogs/Search/sorting) for more details.", "type": "text/plain" }, "key": "sort_by", "value": "price.amount:asc,extensions.products(Specification).rating:desc" }, { "disabled": false, "description": { "content": "Maximum number of facet values to return", "type": "text/plain" }, "key": "max_facet_values", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "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 \"type\": \"search\",\n \"facet_counts\": [\n {\n \"counts\": [\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n },\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n }\n ],\n \"field_name\": \"category\",\n \"sampled\": false,\n \"stats\": {}\n },\n {\n \"counts\": [\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n },\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n }\n ],\n \"field_name\": \"category\",\n \"sampled\": false,\n \"stats\": {}\n }\n ],\n \"found\": 150,\n \"hits\": [\n {\n \"document\": {\n \"attributes\": {},\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {},\n \"type\": \"product\",\n \"meta\": {}\n },\n \"highlight\": {}\n },\n {\n \"document\": {\n \"attributes\": {},\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {},\n \"type\": \"product\",\n \"meta\": {}\n },\n \"highlight\": {}\n }\n ],\n \"out_of\": 150,\n \"page\": 1,\n \"request_params\": {},\n \"search_cutoff\": false,\n \"search_time_ms\": 25,\n \"included\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b15e6c64-b32d-4b3a-8873-9fc44e86ea85", "name": "Bad request - invalid search parameters", "originalRequest": { "url": { "path": [ "pcm", "catalog", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" }, { "disabled": false, "description": { "content": "Type of search operation to perform (This can only be one of search,autocomplete)", "type": "text/plain" }, "key": "type", "value": "search" }, { "disabled": false, "description": { "content": "Comma-separated list of fields to highlight", "type": "text/plain" }, "key": "highlight_full_fields", "value": "name,description" }, { "disabled": false, "description": { "content": "(Required) Search query", "type": "text/plain" }, "key": "q", "value": "search query" }, { "disabled": false, "description": { "content": "Specifies which fields to use for generating facets in search results. See [faceting](/guides/How-To/Catalogs/Search/faceting) for more details.", "type": "text/plain" }, "key": "facet_by", "value": "meta.search.nodes.name" }, { "disabled": false, "description": { "content": "Applies conditions to narrow down search results based on specific field values. See [filtering](/guides/How-To/Catalogs/Search/filtering) for more details.", "type": "text/plain" }, "key": "filter_by", "value": "meta.search.nodes.name:=Electronics && price.float_price:>=10.00" }, { "disabled": false, "description": { "content": "Orders search results by specified fields. See [sorting](/guides/How-To/Catalogs/Search/sorting) for more details.", "type": "text/plain" }, "key": "sort_by", "value": "price.amount:asc,extensions.products(Specification).rating:desc" }, { "disabled": false, "description": { "content": "Maximum number of facet values to return", "type": "text/plain" }, "key": "max_facet_values", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Invalid Filter\",\n \"status\": \"400\",\n \"detail\": \"Could not parse the filter query.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43330156-aa92-4850-8905-5886e86f61aa", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalog", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" }, { "disabled": false, "description": { "content": "Type of search operation to perform (This can only be one of search,autocomplete)", "type": "text/plain" }, "key": "type", "value": "search" }, { "disabled": false, "description": { "content": "Comma-separated list of fields to highlight", "type": "text/plain" }, "key": "highlight_full_fields", "value": "name,description" }, { "disabled": false, "description": { "content": "(Required) Search query", "type": "text/plain" }, "key": "q", "value": "search query" }, { "disabled": false, "description": { "content": "Specifies which fields to use for generating facets in search results. See [faceting](/guides/How-To/Catalogs/Search/faceting) for more details.", "type": "text/plain" }, "key": "facet_by", "value": "meta.search.nodes.name" }, { "disabled": false, "description": { "content": "Applies conditions to narrow down search results based on specific field values. See [filtering](/guides/How-To/Catalogs/Search/filtering) for more details.", "type": "text/plain" }, "key": "filter_by", "value": "meta.search.nodes.name:=Electronics && price.float_price:>=10.00" }, { "disabled": false, "description": { "content": "Orders search results by specified fields. See [sorting](/guides/How-To/Catalogs/Search/sorting) for more details.", "type": "text/plain" }, "key": "sort_by", "value": "price.amount:asc,extensions.products(Specification).rating:desc" }, { "disabled": false, "description": { "content": "Maximum number of facet values to return", "type": "text/plain" }, "key": "max_facet_values", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.", "type": "text/plain" }, "key": "EP-Channel", "value": "string" }, { "disabled": false, "description": { "content": "Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.", "type": "text/plain" }, "key": "EP-Context-Tag", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4052728-537f-43c1-a170-3fc58cd0b7eb", "name": "Admin Search", "request": { "name": "Admin Search", "description": { "content": "Execute search.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", ":catalog_id", "releases", ":release_id", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" }, { "disabled": false, "description": { "content": "Type of search operation to perform (This can only be one of search,autocomplete)", "type": "text/plain" }, "key": "type", "value": "search" }, { "disabled": false, "description": { "content": "Comma-separated list of fields to highlight", "type": "text/plain" }, "key": "highlight_full_fields", "value": "name,description" }, { "disabled": false, "description": { "content": "(Required) Search query", "type": "text/plain" }, "key": "q", "value": "search query" }, { "disabled": false, "description": { "content": "Specifies which fields to use for generating facets in search results. See [faceting](/guides/How-To/Catalogs/Search/faceting) for more details.", "type": "text/plain" }, "key": "facet_by", "value": "meta.search.nodes.name" }, { "disabled": false, "description": { "content": "Applies conditions to narrow down search results based on specific field values. See [filtering](/guides/How-To/Catalogs/Search/filtering) for more details.", "type": "text/plain" }, "key": "filter_by", "value": "meta.search.nodes.name:=Electronics && price.float_price:>=10.00" }, { "disabled": false, "description": { "content": "Orders search results by specified fields. See [sorting](/guides/How-To/Catalogs/Search/sorting) for more details.", "type": "text/plain" }, "key": "sort_by", "value": "price.amount:asc,extensions.products(Specification).rating:desc" }, { "disabled": false, "description": { "content": "Maximum number of facet values to return", "type": "text/plain" }, "key": "max_facet_values", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [ { "type": "any", "value": "string", "key": "catalog_id", "disabled": false, "description": { "content": "(Required) The ID of the catalog to query", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "release_id", "disabled": false, "description": { "content": "(Required) The unique ID of a published release of the catalog or `latestPublished` for the most recently published version", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "eb1654e4-a067-4083-8d8b-b5e643a4bbd1", "name": "Search results", "originalRequest": { "url": { "path": [ "pcm", "catalogs", ":catalog_id", "releases", ":release_id", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" }, { "disabled": false, "description": { "content": "Type of search operation to perform (This can only be one of search,autocomplete)", "type": "text/plain" }, "key": "type", "value": "search" }, { "disabled": false, "description": { "content": "Comma-separated list of fields to highlight", "type": "text/plain" }, "key": "highlight_full_fields", "value": "name,description" }, { "disabled": false, "description": { "content": "(Required) Search query", "type": "text/plain" }, "key": "q", "value": "search query" }, { "disabled": false, "description": { "content": "Specifies which fields to use for generating facets in search results. See [faceting](/guides/How-To/Catalogs/Search/faceting) for more details.", "type": "text/plain" }, "key": "facet_by", "value": "meta.search.nodes.name" }, { "disabled": false, "description": { "content": "Applies conditions to narrow down search results based on specific field values. See [filtering](/guides/How-To/Catalogs/Search/filtering) for more details.", "type": "text/plain" }, "key": "filter_by", "value": "meta.search.nodes.name:=Electronics && price.float_price:>=10.00" }, { "disabled": false, "description": { "content": "Orders search results by specified fields. See [sorting](/guides/How-To/Catalogs/Search/sorting) for more details.", "type": "text/plain" }, "key": "sort_by", "value": "price.amount:asc,extensions.products(Specification).rating:desc" }, { "disabled": false, "description": { "content": "Maximum number of facet values to return", "type": "text/plain" }, "key": "max_facet_values", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the catalog to query", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique ID of a published release of the catalog or `latestPublished` for the most recently published version", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "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 \"type\": \"search\",\n \"facet_counts\": [\n {\n \"counts\": [\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n },\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n }\n ],\n \"field_name\": \"category\",\n \"sampled\": false,\n \"stats\": {}\n },\n {\n \"counts\": [\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n },\n {\n \"count\": 42,\n \"highlighted\": \"electronics\",\n \"value\": \"electronics\"\n }\n ],\n \"field_name\": \"category\",\n \"sampled\": false,\n \"stats\": {}\n }\n ],\n \"found\": 150,\n \"hits\": [\n {\n \"document\": {\n \"attributes\": {},\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {},\n \"type\": \"product\",\n \"meta\": {}\n },\n \"highlight\": {}\n },\n {\n \"document\": {\n \"attributes\": {},\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"relationships\": {},\n \"type\": \"product\",\n \"meta\": {}\n },\n \"highlight\": {}\n }\n ],\n \"out_of\": 150,\n \"page\": 1,\n \"request_params\": {},\n \"search_cutoff\": false,\n \"search_time_ms\": 25,\n \"included\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3a3afa7-9f9d-4359-a26c-0d30f3f3216b", "name": "Bad request - invalid search parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", ":catalog_id", "releases", ":release_id", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" }, { "disabled": false, "description": { "content": "Type of search operation to perform (This can only be one of search,autocomplete)", "type": "text/plain" }, "key": "type", "value": "search" }, { "disabled": false, "description": { "content": "Comma-separated list of fields to highlight", "type": "text/plain" }, "key": "highlight_full_fields", "value": "name,description" }, { "disabled": false, "description": { "content": "(Required) Search query", "type": "text/plain" }, "key": "q", "value": "search query" }, { "disabled": false, "description": { "content": "Specifies which fields to use for generating facets in search results. See [faceting](/guides/How-To/Catalogs/Search/faceting) for more details.", "type": "text/plain" }, "key": "facet_by", "value": "meta.search.nodes.name" }, { "disabled": false, "description": { "content": "Applies conditions to narrow down search results based on specific field values. See [filtering](/guides/How-To/Catalogs/Search/filtering) for more details.", "type": "text/plain" }, "key": "filter_by", "value": "meta.search.nodes.name:=Electronics && price.float_price:>=10.00" }, { "disabled": false, "description": { "content": "Orders search results by specified fields. See [sorting](/guides/How-To/Catalogs/Search/sorting) for more details.", "type": "text/plain" }, "key": "sort_by", "value": "price.amount:asc,extensions.products(Specification).rating:desc" }, { "disabled": false, "description": { "content": "Maximum number of facet values to return", "type": "text/plain" }, "key": "max_facet_values", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the catalog to query", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique ID of a published release of the catalog or `latestPublished` for the most recently published version", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Invalid Filter\",\n \"status\": \"400\",\n \"detail\": \"Could not parse the filter query.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb97ee15-3fa2-4f70-957d-3dd310982e17", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", ":catalog_id", "releases", ":release_id", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,component_products" }, { "disabled": false, "description": { "content": "The slug of the search profile to use for this search. Do not specify to use default search profile.", "type": "text/plain" }, "key": "search_profile", "value": "clothing" }, { "disabled": false, "description": { "content": "Type of search operation to perform (This can only be one of search,autocomplete)", "type": "text/plain" }, "key": "type", "value": "search" }, { "disabled": false, "description": { "content": "Comma-separated list of fields to highlight", "type": "text/plain" }, "key": "highlight_full_fields", "value": "name,description" }, { "disabled": false, "description": { "content": "(Required) Search query", "type": "text/plain" }, "key": "q", "value": "search query" }, { "disabled": false, "description": { "content": "Specifies which fields to use for generating facets in search results. See [faceting](/guides/How-To/Catalogs/Search/faceting) for more details.", "type": "text/plain" }, "key": "facet_by", "value": "meta.search.nodes.name" }, { "disabled": false, "description": { "content": "Applies conditions to narrow down search results based on specific field values. See [filtering](/guides/How-To/Catalogs/Search/filtering) for more details.", "type": "text/plain" }, "key": "filter_by", "value": "meta.search.nodes.name:=Electronics && price.float_price:>=10.00" }, { "disabled": false, "description": { "content": "Orders search results by specified fields. See [sorting](/guides/How-To/Catalogs/Search/sorting) for more details.", "type": "text/plain" }, "key": "sort_by", "value": "price.amount:asc,extensions.products(Specification).rating:desc" }, { "disabled": false, "description": { "content": "Maximum number of facet values to return", "type": "text/plain" }, "key": "max_facet_values", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the catalog to query", "type": "text/plain" }, "type": "any", "value": "string", "key": "catalog_id" }, { "disabled": false, "description": { "content": "(Required) The unique ID of a published release of the catalog or `latestPublished` for the most recently published version", "type": "text/plain" }, "type": "any", "value": "string", "key": "release_id" } ] }, "header": [ { "disabled": false, "description": { "content": "The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).", "type": "text/plain" }, "key": "accept-language", "value": "en-US" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be used to lookup product prices from when the catalog supports price segmentation. The first pricebook will be highest priority (if more than one is supplied) and the rest in descending priority order. Used only for admin endpoints that dont support shopper context lookup.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "string,string" }, { "disabled": false, "description": { "content": "Supply a comma delimited list of pricebook ids to be listed in meta sections available prices . 'all' is a permitted value and will ensure all available prices for a product are shown. 'all' is not recommended if there are lots(10+) of available prices due the large response size.", "type": "text/plain" }, "key": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "string,string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "EP-Simulated-Shopper-Date", "value": "string" }, { "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Indexable Fields", "description": "Indexable Fields allow you to extend and fine-tune the search schema. By default, the search index includes all the core product fields like name, description, SKU, slug etc. Indexable Fields let you:\n\n- **Add custom fields** to the index from product extension templates or custom (shopper and admin) attributes\n- **Configure core field behavior** such as stemming and tokenization on built-in fields like `name` and `description`\n- **Control tokenization** at the collection or per-field level using token separators and symbols to index\n\n### When to Use Indexable Fields\n\nUse Indexable Fields when you want to:\n\n- **Search custom attributes**: Enable full-text search on custom product fields like brand, material, or specifications\n- **Filter by custom attributes**: Allow shoppers to filter products by custom fields like color, size, or rating\n- **Facet on custom attributes**: Display aggregated counts for custom field values in your navigation\n- **Sort by custom attributes**: Order search results by custom numeric fields like rating or popularity\n- **Enable stemming**: Match different word forms (e.g., \"running\" also matches \"run\", \"runs\") on both custom or core fields\n- **Customize tokenization**: Control how hyphenated, compound, or symbol-containing text is split and indexed\n\n### How Indexable Fields Work\n\n1. **Create indexable fields**: Define custom fields to index and configure collection-level or per-field tokenization settings\n2. **Override core field behavior**: Use `core_field_overrides` to configure stemming, token separators, or symbols to index on built-in fields like `name` and `description`\n3. **Reindex catalogs**: After creating or modifying indexable fields, reindex your catalog releases to apply the changes\n4. **Use in searches**: Once reindexed, custom fields are available in search queries for filtering, faceting, and sorting\n\n### Field Configuration\n\nEach entry in the custom fields (`fields` array) supports the following options:\n\n| Option | Description |\n|--------------------|-----------------------------------------------------------------------------------------------------------|\n| `name` | The field path — see **Field Types** below for supported formats |\n| `facetable` | When `true`, the field can be used for faceting to show aggregated value counts |\n| `sortable` | When `true`, the field can be used for sorting results |\n| `locale` | Language code for text tokenization, defaults to `en` for English |\n| `stem` | When `true`, enables word stemming using the Snowball stemmer — see **Stemming** below |\n| `token_separators` | Per-field characters to use as token separators, overriding the collection-level setting |\n| `symbols_to_index` | Per-field special characters to preserve as part of tokens, overriding the collection-level setting |\n\n### Field Types\n\nTwo categories of fields can be indexed:\n\n#### Extension Fields\n\nFields from your product extension templates, following the pattern `extensions.products().`:\n\n- `` is the slug of your product extension template\n- `` is the name of the field within that template\n- The field must exist and be enabled in the flows service\n- Only enumerated string fields, numeric fields, and boolean fields can be faceted\n\n**Example**: For a product extension template with slug `Details` containing a field `brand`, the indexable field name would be `extensions.products(Details).brand`.\n\n#### Custom Attribute Fields\n\nMerchant-defined key/value attributes stored directly on products:\n\n- `shopper_attributes.` — visible in shopper and admin catalog API responses and available for filtering, sorting, and faceting in both shopper and admin search\n- `admin_attributes.` — available for filtering and sorting in both shopper and admin search; not returned in search response payloads\n- `` must be no longer than **64 characters** and can only contain alphanumeric characters, underscores (`_`), and hyphens (`-`).\n- Attribute fields are always typed as `string`\n- Faceting and sorting can be enabled\n\n**Examples**: `shopper_attributes.fabric`, `admin_attributes.internal_grade`\n\n### Core Field Overrides\n\nIn addition to configuring custom fields, Indexable Fields can influence the behavior of built-in product fields such as `name`, `description`, and `sku`. Use the `core_field_overrides` to apply per-field settings.\n\nEach entry in `core_field_overrides` supports `stem`, `token_separators`, `symbols_to_index`, and `sortable`. This is useful when you want to enable stemming on the product description, apply custom tokenization to a specific core field, or enable sorting on fields like `name` and `sku`.\n\n**Example**: Enable stemming on `description` and treat hyphens as token separators only on `name`:\n\n```json\n{\n \"core_field_overrides\": [\n { \"name\": \"description\", \"stem\": true },\n { \"name\": \"name\", \"token_separators\": [\"-\"], \"sortable\": true }\n ]\n}\n```\n\n### Stemming\n\nStemming reduces words to their root form at both index and query time, so a search for \"running\" also matches products containing \"run\", \"runs\", or \"runner\". This improves search recall for descriptive text fields where shoppers may use different word forms than those found in product data.\n\n- Enable per field using `stem: true` on any entry in `fields` or `core_field_overrides`\n- Uses the [Snowball stemmer](https://snowballstem.org/)\n- Only valid for string-typed fields\n- Defaults to `false`\n\n### Token Separators and Symbols to Index\n\nThese settings control how text is split into tokens during indexing and searching.\n\n#### Token Separators\n\n`token_separators` specifies characters that split text into separate tokens, in addition to the default whitespace splitting. This is useful for hyphenated text, part numbers, or other compound formats.\n\nFor example, with `token_separators: [\"-\"]`, the text `non-tech` is tokenized to `non` and `tech`, so searches for both `non-tech` and `non tech` will match.\n\n#### Symbols to Index\n\n`symbols_to_index` specifies special characters that should be preserved within tokens rather than stripped during indexing. Useful when products contain meaningful symbols like `+`, `#`, or `@`.\n\n#### Collection-Level vs Field-Level\n\nBoth settings can be configured at two scopes:\n\n- **Collection-level**: Set `token_separators` or `symbols_to_index` at the top level of the indexable fields resource to apply the setting across all indexed fields.\n- **Field-level**: Set the same properties on an individual entry in `fields` or `core_field_overrides` to apply only to that field, overriding the collection-level setting.\n\nAn empty array at the field level defers to the collection-level setting.\n\n### Reindexing Requirement\n\nAny change to indexable fields requires reindexing your catalog releases to take effect. The system detects when indexes are out of sync. Use the [reindex endpoint](/docs/api/pxm/catalog-search/reindex-tenant-releases) to apply changes. See [Jobs](/docs/api/pxm/catalog-search/jobs) for more details on reindexing operations.\n", "item": [ { "id": "b84d2b37-14a4-4f5e-a2c1-c915d7905680", "name": "Create indexable fields", "request": { "name": "Create indexable fields", "description": { "content": "Specify additional fields to be indexed.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "indexable-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "dca0cd8c-e075-4e8c-99fa-3a10de9f26bd", "name": "Successfully created indexable fields", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"type\": \"string\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"type\": \"string\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"type\": \"string\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n },\n \"meta\": {\n \"owner\": \"organization\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dbe8eac-dccd-4518-84fd-06cc591f7d31", "name": "Bad request - invalid search parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "549fc2ad-3d34-4507-af91-6a3f237a4ec8", "name": "Conflict - reindexing job queued or in progress", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc392fc5-9750-4c55-a949-d492b7a472c2", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52baecee-89e5-4a19-bf27-83cd48d04fc4", "name": "List indexable fields", "request": { "name": "List indexable fields", "description": { "content": "List indexable fields.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "indexable-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "573a2639-3b97-492f-a953-3c0a93ddb0be", "name": "List indexable fields", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields" ], "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" } ], "body": "{\n \"data\": [\n {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"type\": \"string\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"type\": \"string\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"type\": \"string\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n },\n \"meta\": {\n \"owner\": \"organization\"\n }\n },\n {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"type\": \"string\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"type\": \"string\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"type\": \"string\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n },\n \"meta\": {\n \"owner\": \"organization\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f61e44dc-794f-42bd-b565-de1dea2d22b1", "name": "Bad request - invalid search parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields" ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33fe365a-d2bf-420e-be73-28e54c54cd82", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb5ff77b-dd1a-4c62-9a1c-970e9fc22475", "name": "Get indexable fields", "request": { "name": "Get indexable fields", "description": { "content": "Get additional fields to be indexed.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id", "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f5dc40a3-bef7-42ef-a6b7-abc4f81d05c8", "name": "Get indexable fields", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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 \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"type\": \"string\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"type\": \"string\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"type\": \"string\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n },\n \"meta\": {\n \"owner\": \"organization\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5adc7f9f-9a68-413f-a698-e28287577f2b", "name": "Bad request - invalid search parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b049d5b-53eb-4bb5-8be9-e70f5118a8ff", "name": "Indexable fields not found", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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 \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f4fa2e8-ac5d-425d-a0fc-f74ad2f9fb62", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d8b505f6-b8df-405b-be7c-6729d94618df", "name": "Update indexable fields", "request": { "name": "Update indexable fields", "description": { "content": "Update additional fields to be indexed.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id", "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5505612b-5043-4971-8e5e-c9fac9c26c9b", "name": "Successfully updated indexable fields", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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 \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\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 \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"type\": \"string\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"type\": \"string\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"type\": \"string\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n },\n \"meta\": {\n \"owner\": \"organization\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e16565b8-1a2e-4f46-9fee-ad30050f1002", "name": "Bad request - invalid search parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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 \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c310a9a-712d-49de-928e-c1589e4eb340", "name": "Permission denied - indexable fields owned by the organization", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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 \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c9deaa3-5f6d-4adf-874a-fbddd69b0990", "name": "Indexable fields not found", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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 \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00117b33-131e-47ad-ae31-09d3bc7a760a", "name": "Conflict - reindexing job queued or in progress", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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 \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05c35661-aa97-4efc-8bf5-05acc9f584ab", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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 \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_indexable_fields\",\n \"attributes\": {\n \"fields\": [\n {\n \"name\": \"extensions.products(clothing).color\",\n \"facetable\": false,\n \"sortable\": false,\n \"locale\": \"en\"\n },\n {\n \"name\": \"shopper_attributes.fabric\",\n \"facetable\": false,\n \"sortable\": false\n },\n {\n \"name\": \"admin_attributes.internal_grade\",\n \"sortable\": true\n }\n ],\n \"core_field_overrides\": [\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n },\n {\n \"name\": \"name\",\n \"stem\": true,\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ],\n \"sortable\": true\n }\n ],\n \"token_separators\": [\n \"s\",\n \"s\"\n ],\n \"symbols_to_index\": [\n \"s\",\n \"s\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "daf0d92d-a0eb-42cc-bbc4-be13e704ab14", "name": "Delete indexable fields", "request": { "name": "Delete indexable fields", "description": { "content": "Delete additional fields to be indexed.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id", "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "2a26d61a-70c5-473f-96a9-30e6e578ea0a", "name": "Successfully deleted indexable fields", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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": "90367fe5-bfac-4aa8-9110-03d06c330744", "name": "Bad request - invalid search parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d23292ee-3fb4-4922-a898-344e523e096b", "name": "Permission denied - indexable fields owned by the organization", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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 \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5352f6f8-e41c-4107-a126-b45c7a6e6033", "name": "Conflict - reindexing job queued or in progress", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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 \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d7a3f64-55e1-49bd-bead-119ef44f4be6", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "indexable-fields", ":indexable_fields_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the indexable fields", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "indexable_fields_id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Searchable Fields", "description": "The Searchable Fields API returns a list of all fields available for searching, filtering, faceting, and sorting in your search queries. This includes both the standard product fields that are indexed by default and any custom fields you've added through Indexable Fields.\n\n### Using Searchable Fields\n\nUse this endpoint to:\n\n- **Discover available fields**: See all fields that can be used in search queries\n- **Build dynamic UIs**: Programmatically generate filter and facet options based on available fields\n- **Validate configurations**: Verify that your indexable fields have been properly added to the schema\n\n### Field Properties\n\nEach searchable field includes:\n\n| Property | Description |\n| --- | --- |\n| `name` | The field name to use in search queries |\n| `type` | The data type (`string`, `int32`, `int64`, `float`, `bool`) |\n| `facetable` | Whether the field can be used for faceting |\n| `sortable` | Whether the field can be used for sorting |\n| `locale` | The language code for text fields |\n\n### Standard vs Custom Fields\n\n- **Standard fields**: Built-in fields like `name`, `description`, `sku`, `meta.search.nodes.name` that are always available\n- **Custom fields**: Fields added through Indexable Fields from your product extensions\n", "item": [ { "id": "de8166e0-5245-4ffc-9673-eb42941030de", "name": "List searchable fields", "request": { "name": "List searchable fields", "description": { "content": "List searchable fields.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "searchable-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5ac7d2e8-751e-40d8-b02c-e8f2a8ad07db", "name": "List searchable fields", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "searchable-fields" ], "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" } ], "body": "{\n \"data\": [\n {\n \"id\": \"name\",\n \"type\": \"catalog_searchable_field\",\n \"attributes\": {\n \"name\": \"name\",\n \"type\": \"string\",\n \"facetable\": true,\n \"sortable\": true,\n \"locale\": \"en\"\n },\n \"meta\": {\n \"owner\": \"organization\"\n }\n },\n {\n \"id\": \"name\",\n \"type\": \"catalog_searchable_field\",\n \"attributes\": {\n \"name\": \"name\",\n \"type\": \"string\",\n \"facetable\": true,\n \"sortable\": true,\n \"locale\": \"en\"\n },\n \"meta\": {\n \"owner\": \"organization\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 100\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51433a45-8e34-4174-af12-bcd1b81dfede", "name": "Bad request - invalid search parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "searchable-fields" ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9aaa69d7-d00b-43a6-9c1f-00dd16987d23", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "searchable-fields" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Search Profiles", "description": "Search Profiles are configuration objects that control how search queries are executed. They provide a powerful way to customize search relevance, filtering, and ranking without requiring code changes, enabling merchandisers and business users to optimize the search experience.\n\n### How Search Profiles Work\n\nA Search Profile defines:\n\n- **Which fields to search**: Select which product fields are included in search queries\n- **Field weights**: Assign relative importance to each field for relevance ranking\n- **Default filters**: Apply business rules that filter results for all searches\n- **Boost rules**: Promote or demote products based on specific conditions\n- **Match type**: Control how scores from multiple fields are combined\n\nWhen a search request is made, the system uses the specified profile (or the default profile) to configure the search behavior.\n\n### Search Profile Components\n\n| Component | Description |\n|-------------------|-------------------------------------------------------------------------------------------|\n| `slug` | Unique identifier used to reference the profile in search requests |\n| `fields` | List of fields to search with optional weights for relevance ranking |\n| `filters` | Default filter expressions applied to all searches using this profile |\n| `boosts` | Rules for promoting or demoting products based on conditions |\n| `text_match_type` | How to combine scores when multiple fields match (`max_score`, `max_weight`, `sum_score`) |\n\n### Field Weights\n\nField weights control how important each field is when ranking search results. Higher weights mean matches in that field contribute more to the relevance score. Weights must be in the range `[0, 15]`.\n\n**Example**: A profile with `name` (weight 10) and `description` (weight 5) will rank products with search term matches in the name higher than those with matches only in the description.\n\n### Filters\n\nProfile filters enforce business rules that apply to all searches:\n\n- Ensure only live/published products appear in results\n- Restrict results to specific categories or channels\n- Hide products based on visibility settings\n\nMultiple filters are combined with OR logic, then ANDed with any filters in the search request.\n\n### Boost Rules\n\nBoost rules allow you to promote or demote products in search results:\n\n- **Positive weights**: Push matching products to the top of results\n- **Negative weights**: Push matching products to the bottom (burying)\n- **Zero weight**: No effect on ranking\n\nRules are evaluated in weight order, and the first matching rule determines the product's boost.\n\n### Text Match Types\n\n| Type | Description |\n|--------------|----------------------------------------------------------------------------------------|\n| `max_score` | Uses the highest score from any single matching field. Prioritizes match quality. |\n| `max_weight` | Uses the score from the highest-weighted matching field. Prioritizes field importance. |\n| `sum_score` | Sums weighted scores from all matching fields. Rewards multi-field matches. |\n\n### Default Profile\n\nEach store has a default search profile that is used when no profile is specified in the search request. You can set any profile as the default using the set default endpoint.\n\n### Use Cases\n\n- **A/B testing**: Create multiple profiles with different configurations to test search relevance\n- **Channel optimization**: Different profiles for web, mobile, and B2B channels\n- **Seasonal merchandising**: Profiles that boost seasonal or promotional products\n- **Customer segmentation**: Different ranking strategies for different customer tiers\n", "item": [ { "id": "def005dc-1ff1-49f5-9b78-36d6f01907d2", "name": "Create search profile", "request": { "name": "Create search profile", "description": { "content": "Create a new search profile.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true,\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ae29d30a-0b1b-4354-9b4e-b481e9717df3", "name": "Successfully created search profile", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true,\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true,\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ]\n },\n \"meta\": {\n \"default\": true,\n \"owner\": \"organization\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d35a9507-2550-4c72-9d8a-31ea32ab801a", "name": "Bad request - invalid parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true,\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d242d85-784b-4f6f-b033-c2b5630a5c94", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true,\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d60da457-7e0b-43c6-b364-ff27b05170ba", "name": "List search profiles", "request": { "name": "List search profiles", "description": { "content": "List search profiles.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7c3a830d-a4c4-4300-8494-216f98e581f3", "name": "List search profiles", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles" ], "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" } ], "body": "{\n \"data\": [\n {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true,\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ]\n },\n \"meta\": {\n \"default\": true,\n \"owner\": \"organization\"\n }\n },\n {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true,\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ]\n },\n \"meta\": {\n \"default\": true,\n \"owner\": \"organization\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 100\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93a42022-8e67-436b-97a0-735116a5baf9", "name": "Bad request - invalid parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles" ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4538963-95d3-4864-af28-d77278f15968", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0436269-3c0c-4353-ac91-9a0644f924bd", "name": "Get search profile", "request": { "name": "Get search profile", "description": { "content": "Get a search profile.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id", "disabled": false, "description": { "content": "(Required) The unique ID of the search profile or 'default' to retrieve the default search profile.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "da52cccd-b13d-47f9-9c1f-6dcca891b891", "name": "Successfully retrieved search profile", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile or 'default' to retrieve the default search profile.", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "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 \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true,\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ]\n },\n \"meta\": {\n \"default\": true,\n \"owner\": \"organization\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c300adc-d124-4d23-aa63-6892e945d100", "name": "Bad request - invalid parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile or 'default' to retrieve the default search profile.", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83d15659-2ab4-4855-b237-4fa37e6e2ca2", "name": "Search profile not found", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile or 'default' to retrieve the default search profile.", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "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 \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adea8838-75ec-4390-8edb-3bad5c9d7386", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile or 'default' to retrieve the default search profile.", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20120e18-10a1-4814-a15f-4133dad91dae", "name": "Update search profile", "request": { "name": "Update search profile", "description": { "content": "Update a search profile.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id", "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7b3cb94e-bc6f-48c7-9350-c2931d2f3eb6", "name": "Successfully updated search profile", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "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 \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true,\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ]\n },\n \"meta\": {\n \"default\": true,\n \"owner\": \"organization\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7aa5695b-66d6-41d6-ba25-649187c45cee", "name": "Bad request - invalid parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "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 \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c05737e-04a1-4e44-b5e1-f32d281afdd7", "name": "Permission denied - search profile owned by the organization", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "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 \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97341256-433d-48b0-b1d5-e54a7079e6ae", "name": "Search profile not found", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "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 \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bd03f13-366b-4978-bbd8-39b359e992ad", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "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 \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73088f5c-f1cd-4014-a888-2faa89663138", "name": "Delete search profile", "request": { "name": "Delete search profile", "description": { "content": "Delete a search profile.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id", "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "51f763ce-6bf1-461b-97b2-2f8f0c8da01d", "name": "Successfully deleted search profile", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "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": "fa13f6e0-9f7f-434c-98f7-6c075ee7b789", "name": "Bad request - invalid parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef4bbf7d-7b61-4209-9441-4c57ced2679b", "name": "Permission denied - search profile owned by the organization", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "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 \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df5bf222-3c8e-4a3d-ae29-06881bc37480", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bcb0d2e2-adc6-4654-a27c-556b65b60cde", "name": "Set search profile as default", "request": { "name": "Set search profile as default", "description": { "content": "Set a search profile as the default.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id", "default" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id", "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "0c919c64-54d8-4347-9b1f-0fc34ffd5691", "name": "Successfully updated the search profile", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id", "default" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "header": [ { "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": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_profile\",\n \"attributes\": {\n \"slug\": \"default\",\n \"description\": \"Default search profile\",\n \"fields\": [\n {\n \"name\": \"name\",\n \"weight\": 10,\n \"num_typos\": 1,\n \"prefix\": true\n }\n ],\n \"force_use_default_price_for_faceting_and_sorting\": true,\n \"text_match_type\": \"max_score\",\n \"filters\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"exclusions\": [\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\",\n \"meta.search.categories.lvl1:=`All Products > Mens Shoes`\"\n ],\n \"boosts\": [\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n },\n {\n \"condition\": \"meta.search.nodes.name:=\\\\`Electronics\\\\`\",\n \"weight\": 5\n }\n ],\n \"prefix\": true,\n \"typo_tolerance\": {\n \"num_typos\": 1,\n \"min_len_to_allow_single_character_correction\": 3,\n \"min_len_to_allow_two_character_correction\": 7,\n \"typo_tokens_threshold\": 1,\n \"drop_tokens_threshold\": 1,\n \"drop_tokens_mode\": \"right_to_left\",\n \"enable_typos_for_numerical_tokens\": true,\n \"enable_typos_for_special_char_tokens\": true,\n \"number_of_typos_allowed_when_resolving_synonyms\": 0,\n \"split_join_tokens\": \"fallback\"\n },\n \"synonym_sets\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ]\n },\n \"meta\": {\n \"default\": true,\n \"owner\": \"organization\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c506c6f6-f26f-4455-b830-3fc9d977c31e", "name": "Bad request - invalid parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id", "default" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "header": [ { "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": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa28d4ae-d176-4d3d-9982-3eeae5884a86", "name": "Permission denied - search profile owned by the organization", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id", "default" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "header": [ { "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": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4be4993-fb7e-4377-be4e-48d4b5c00985", "name": "Search profile not found", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id", "default" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "header": [ { "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": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99ba37bf-4aad-414b-8569-2232fbd92791", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-profiles", ":search_profile_id", "default" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the search profile", "type": "text/plain" }, "type": "any", "value": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b", "key": "search_profile_id" } ] }, "header": [ { "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": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Search Indexes", "description": "Search Indexes represent the indexed data for your catalog releases. Each time a catalog is published with search enabled, a search index is created containing the product data optimized for fast querying.\n\n### Index Status\n\nThe Search Indexes API allows you to view the status of your indexes and identify any that are out of sync. An index becomes out of sync when:\n\n- Indexable fields have been added, modified, or deleted\n- The index failed to build during catalog publishing\n- A reindex is required due to schema changes\n\n### Monitoring Indexes\n\nUse the list endpoint to:\n\n- **View all indexes**: See all search indexes for your store\n- **Check sync status**: Identify indexes that need reindexing\n- **Filter by status**: Find only out-of-sync indexes using the `out_of_sync` query parameter\n\n### Index Information\n\nEach search index includes:\n\n| Property | Description |\n|---------------|---------------------------------------------------------|\n| `catalog_id` | The ID of the catalog this index belongs to |\n| `release_id` | The ID of the catalog release this index was built from |\n| `out_of_sync` | Whether the index needs to be rebuilt |\n\n### Reindexing\n\nWhen indexes are out of sync, use the reindex endpoint in [Jobs](/docs/api/pxm/catalog-search/jobs) to rebuild them. Reindexing ensures your search indexes reflect the current indexable field configuration.\n", "item": [ { "id": "e7433236-b336-4099-96cb-9784a2c926d6", "name": "List search indexes", "request": { "name": "List search indexes", "description": { "content": "List search indexes.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search-indexes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter search indexes by out of sync status", "type": "text/plain" }, "key": "out_of_sync", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0840cd29-ac9d-443f-b04b-e58dbd4e7b9f", "name": "List search indexes", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-indexes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter search indexes by out of sync status", "type": "text/plain" }, "key": "out_of_sync", "value": "true" } ], "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\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_index\",\n \"meta\": {\n \"catalog_id\": \"ac107ce9-96ac-4bd5-aa3d-59f40b91279b\",\n \"release_id\": \"b2ddd253-d9bd-4344-a18b-581c1e0b25f8\",\n \"out_of_sync\": false,\n \"owner\": \"organization\"\n }\n },\n {\n \"id\": \"805103ff-0a37-4f83-8fe0-95a16039bd98\",\n \"type\": \"catalog_search_index\",\n \"meta\": {\n \"catalog_id\": \"ac107ce9-96ac-4bd5-aa3d-59f40b91279b\",\n \"release_id\": \"b2ddd253-d9bd-4344-a18b-581c1e0b25f8\",\n \"out_of_sync\": false,\n \"owner\": \"organization\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 100\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29242522-69b1-4722-8880-e299b4f06c1f", "name": "Bad request - invalid parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-indexes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter search indexes by out of sync status", "type": "text/plain" }, "key": "out_of_sync", "value": "true" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b22134d8-c5a5-431e-b147-4970f3854786", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search-indexes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter search indexes by out of sync status", "type": "text/plain" }, "key": "out_of_sync", "value": "true" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Typesense Clusters", "description": "Manage Typesense clusters (provision via jobs; get/list cluster state including status).", "item": [] }, { "name": "Jobs", "description": "Jobs manage the indexing operations for catalog search. When catalogs are published or when reindexing is required, jobs process the product data and build search indexes.\n\n### Job Types\n\n| Type | Description |\n|---------------------------|-----------------------------------------------------------------------------------------------------|\n| `index-release` | Index a specific catalog release. Created automatically when a search-enabled catalog is published. |\n| `delete-release` | Remove the search index for a catalog release. |\n| `reindex-tenant-releases` | Reindex all catalog releases for the store. Use when indexable fields have changed. |\n\n### Job Lifecycle\n\nJobs progress through the following states:\n\n1. **pending**: Job has been created and is waiting to be processed\n2. **processing**: Job is actively indexing products\n3. **complete**: Job finished successfully\n4. **failed**: Job encountered an error\n\n### Automatic Indexing\n\nWhen you publish a catalog with search enabled, an `index-release` job is automatically created. The catalog release remains in a publishing state until the indexing job completes successfully.\n\n### Manual Reindexing\n\nUse the reindex endpoint when:\n\n- You've added, modified, or deleted indexable fields\n- Search indexes are out of sync (check via [Search Indexes](/docs/api/pxm/catalog-search/search-indexes))\n- You need to rebuild indexes after a failure\n\nThe reindex operation creates jobs for all catalog releases that need updating. You can optionally force a full reindex of all releases regardless of their sync status.\n\n### Conflict Handling\n\nOnly one reindexing operation can run at a time. If you attempt to start a reindex while another is in progress, the API returns a 409 Conflict error.\n", "item": [ { "id": "24cccfda-3eb4-45c9-9ef5-76dddefa55f8", "name": "Reindex all releases for tenant", "request": { "name": "Reindex all releases for tenant", "description": { "content": "Create a new job to reindex all releases for the tenant.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "reindex-releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"force_reindex\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "972baa48-fd2a-47f3-b00a-fc3ece43f208", "name": "Reindex tenant releases request successful", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "reindex-releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"force_reindex\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"4c9efe34-57bb-4117-abed-184008d3ae0a\",\n \"type\": \"job\",\n \"attributes\": {\n \"status\": \"pending\",\n \"type\": \"index-release\",\n \"catalog_id\": \"ac107ce9-96ac-4bd5-aa3d-59f40b91279b\",\n \"catalog_release_id\": \"c12c4e5b-f5e4-4bd0-ac86-9f1202fc27f9\"\n },\n \"meta\": {\n \"errors\": [\n {\n \"detail\": \"Failed to get release\",\n \"context\": {}\n },\n {\n \"detail\": \"Failed to get release\",\n \"context\": {}\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4ebe04c-9e5d-4cbf-84fc-e87b2735a2e8", "name": "Bad request", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "reindex-releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"force_reindex\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84154001-70a7-4008-970a-d936fda07378", "name": "Conflict - another reindexing job already queued or in progress", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "reindex-releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"force_reindex\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daa7bb25-93ed-40c8-b2d5-59764c1fedaa", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "reindex-releases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"force_reindex\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Stopword Sets", "description": "Stopword Sets allow you to define sets of common words (such as \"the\", \"a\", \"an\", \"is\") that should be ignored during search queries. By removing these low-value terms from search processing, you can improve search relevance and reduce noise in results.\n\n### How Stopword Sets Work\n\nA stopword set is a named container of stopword words. Each set belongs to an organization or store and is synced asynchronously. Once synced, the stopwords are applied during search query processing to filter out the specified terms.\n\n### Common Stopwords\n\nStopword sets contain a flat list of words to ignore:\n\n- **Common articles**: \"the\", \"a\", \"an\"\n- **Prepositions**: \"in\", \"on\", \"at\", \"for\"\n- **Conjunctions**: \"and\", \"or\", \"but\"\n\n### Sync Status\n\nStopword sets are synced asynchronously. The sync status is tracked and exposed in API responses:\n\n| Status | Description |\n|------------------|----------------------------------------------------------------|\n| `pending_sync` | Set has been created or updated in MongoDB but not yet synced |\n| `synced` | Set has been successfully synced |\n| `sync_failed` | The last sync attempt failed |\n| `pending_delete` | Set is marked for deletion; a background worker will remove it |\n\n### Tenancy\n\nStopword sets follow the same tenancy model as other resources:\n\n- **Organization-scoped sets**: Managed by the organization; apply across all stores\n- **Store-scoped sets**: Managed by the store; apply only to that store\n\nStores cannot modify organization-scoped stopword sets.\n", "item": [ { "id": "511a4379-9b16-42b0-bec3-162e660dbf45", "name": "Create stopword set", "request": { "name": "Create stopword set", "description": { "content": "Create a new stopwords set.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\",\n \"is\"\n ],\n \"locale\": \"en\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "52aa2849-b173-4fb0-a325-4040f3a73074", "name": "Successfully created stopword set", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\",\n \"is\"\n ],\n \"locale\": \"en\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\",\n \"is\"\n ],\n \"locale\": \"en\"\n },\n \"meta\": {\n \"created_at\": \"2026-03-05T12:00:00Z\",\n \"updated_at\": \"2026-03-05T12:00:00Z\",\n \"owner\": \"organization\",\n \"sync_status\": \"pending_sync\",\n \"last_synced_at\": \"2026-03-05T12:01:00Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0410c2f2-4694-427e-937e-62f65c0f3b0f", "name": "Bad request - invalid parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\",\n \"is\"\n ],\n \"locale\": \"en\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19095001-baf2-41fc-a98c-f5236dfe574a", "name": "Conflict - a stopwords set for the given locale already exists", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\",\n \"is\"\n ],\n \"locale\": \"en\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83cc2b15-6c06-4e4a-b820-b51e663971cb", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\",\n \"is\"\n ],\n \"locale\": \"en\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e04c9191-5fd8-4619-82bd-bb2aec5b5d2d", "name": "List stopword sets", "request": { "name": "List stopword sets", "description": { "content": "List all stopwords sets.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "28d9263d-2a52-4f1f-ae31-9e5b434643d0", "name": "Successfully listed stopword sets", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets" ], "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" } ], "body": "{\n \"data\": [\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\",\n \"is\"\n ],\n \"locale\": \"en\"\n },\n \"meta\": {\n \"created_at\": \"2026-03-05T12:00:00Z\",\n \"updated_at\": \"2026-03-05T12:00:00Z\",\n \"owner\": \"organization\",\n \"sync_status\": \"pending_sync\",\n \"last_synced_at\": \"2026-03-05T12:01:00Z\"\n }\n },\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\",\n \"is\"\n ],\n \"locale\": \"en\"\n },\n \"meta\": {\n \"created_at\": \"2026-03-05T12:00:00Z\",\n \"updated_at\": \"2026-03-05T12:00:00Z\",\n \"owner\": \"organization\",\n \"sync_status\": \"pending_sync\",\n \"last_synced_at\": \"2026-03-05T12:01:00Z\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 100\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23e51c7a-ea2d-4fbb-aec3-4ab357582e2c", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c37ffee-e946-43d2-a60e-dc5f09148bbf", "name": "Get stopword set", "request": { "name": "Get stopword set", "description": { "content": "Get a stopwords set by ID.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id", "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3abf89ac-1728-4179-b779-f71c2b6e3c1b", "name": "Successfully retrieved stopword set", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id" } ] }, "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 \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\",\n \"is\"\n ],\n \"locale\": \"en\"\n },\n \"meta\": {\n \"created_at\": \"2026-03-05T12:00:00Z\",\n \"updated_at\": \"2026-03-05T12:00:00Z\",\n \"owner\": \"organization\",\n \"sync_status\": \"pending_sync\",\n \"last_synced_at\": \"2026-03-05T12:01:00Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5eb52c4e-1e90-4d1d-9bf4-93b6466132de", "name": "Stopword set not found", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id" } ] }, "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 \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23178111-f768-49b5-8132-48f024f6e6c6", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c93dcc7-7aeb-4517-b10f-266f2647caf7", "name": "Update stopword set", "request": { "name": "Update stopword set", "description": { "content": "Update the stopwords in an existing stopwords set. The locale cannot be changed.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id", "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "71e887a2-f768-441b-b086-d94b0b6faba7", "name": "Successfully updated stopword set", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id" } ] }, "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 \"data\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\"\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 \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\",\n \"is\"\n ],\n \"locale\": \"en\"\n },\n \"meta\": {\n \"created_at\": \"2026-03-05T12:00:00Z\",\n \"updated_at\": \"2026-03-05T12:00:00Z\",\n \"owner\": \"organization\",\n \"sync_status\": \"pending_sync\",\n \"last_synced_at\": \"2026-03-05T12:01:00Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95c030c3-9ed5-479a-b045-1a5d085d345c", "name": "Bad request - invalid parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id" } ] }, "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 \"data\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc005f0f-3316-4e32-a61c-2418f30524c2", "name": "Permission denied", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id" } ] }, "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 \"data\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad5c3a99-99c4-42f2-a3b7-72d47c4eb439", "name": "Stopword set not found", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id" } ] }, "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 \"data\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af50065a-8937-41b2-8ff5-6a419bdee438", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id" } ] }, "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 \"data\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_stopword_set\",\n \"attributes\": {\n \"stopwords\": [\n \"the\",\n \"a\",\n \"an\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2ac1bb2-887f-4756-b598-1fe446e91217", "name": "Delete stopword set", "request": { "name": "Delete stopword set", "description": { "content": "Delete a stopword set by ID.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id", "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "9aadeae3-8ee1-4955-913a-95791b84244d", "name": "Stopword set marked for deletion", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id" } ] }, "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": "dc6560e8-d9ef-4702-97f3-3992b7566dbf", "name": "Permission denied", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id" } ] }, "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 \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8acbff49-9833-4d67-a43c-293d9930fbf7", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "stopword-sets", ":stopword_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the stopword set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "stopword_set_id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Synonym Sets", "description": "Synonym Sets allow you to define groups of equivalent or related terms so that searches for one term also return results for its synonyms. This helps shoppers find products regardless of the specific terminology they use.\n\n### How Synonym Sets Work\n\nA synonym set is a named container of synonym items. Each set belongs to an organization or store and is synced asynchronously. Once synced, a set can be attached to one or more search profiles; its synonym rules are then applied during searches that use those profiles to expand queries with matching terms.\n\n### Synonym Types\n\nEach item within a synonym set can be either multi-way or one-way:\n\n- **Multi-way synonyms**: All terms are treated as equivalent. Searching for any term in the list returns results for all of them. For example, `[\"sneakers\", \"trainers\", \"running shoes\"]` means a search for \"trainers\" also returns results for \"sneakers\" and \"running shoes\".\n- **One-way synonyms**: Searches for a `root` term also match the `synonyms`, but not vice versa. For example, with `root: \"jacket\"` and `synonyms: [\"blazer\", \"coat\"]`, searching for \"jacket\" also returns results for \"blazer\" and \"coat\", but searching for \"blazer\" does not return results for \"jacket\".\n\n### Synonym Item Configuration\n\nEach item within a synonym set supports the following options:\n\n| Option | Required | Description |\n|--------------------|----------|--------------------------------------------------------------------------------------------------------------|\n| `id` | Yes | Unique identifier for the item within the set. Alphanumeric characters, hyphens, and underscores only. |\n| `synonyms` | Yes | List of synonym terms. Minimum 1 if `root` is provided (one-way), minimum 2 if `root` is absent (multi-way). |\n| `root` | No | Makes this a one-way synonym. Must not also appear in the `synonyms` array. |\n| `locale` | No | ISO 639 language code for this synonym item. |\n| `symbols_to_index` | No | Special characters to preserve as part of tokens. Each element must be exactly one character. |\n\n### Sync Status\n\nSynonym sets are synced asynchronously. The sync status is tracked and exposed in API responses:\n\n| Status | Description |\n|------------------|----------------------------------------------------------------|\n| `pending_sync` | Set has been created or updated in MongoDB but not yet synced |\n| `synced` | Set has been successfully synced |\n| `sync_failed` | The last sync attempt failed |\n| `pending_delete` | Set is marked for deletion; a background worker will remove it |\n\n### Tenancy\n\nSynonym sets follow the same tenancy model as other resources:\n\n- **Organization-scoped sets**: Managed by the organization; apply across all stores\n- **Store-scoped sets**: Managed by the store; apply only to that store\n\nStores cannot modify organization-scoped synonym sets.\n\n### Using Synonym Sets in Search Profiles\n\nSynonym sets only take effect once they are attached to a [search profile](/docs/api/pxm/catalog-search/search-profiles) via its `synonym_sets` attribute. At search time, the synonym sets of the resolved search profile are applied to the query.\n\nWhen attaching a synonym set to a search profile:\n\n- The set must exist and be accessible by the calling tenant. Organization-level search profiles may only reference organization-level sets; store-level search profiles may reference organization-level and same-store sets.\n- The set must have been synced at least once. A set in `pending_sync` or `sync_failed` state can still be used if it was previously synced — its last synced state continues to apply.\n\nA synonym set cannot be deleted while it is referenced by any search profile; the delete request is rejected with a `409 Conflict` until the reference is removed.\n\n### Use Cases\n\n- **Regional terminology**: Map British and American English terms (e.g., \"trousers\" ↔ \"pants\")\n- **Brand equivalents**: Link product category names with common alternatives\n- **Industry jargon**: Ensure technical terms match colloquial ones\n- **Abbreviations**: Map abbreviations to their full forms (e.g., \"tee\" → \"t-shirt\")\n", "item": [ { "id": "3a78f01c-532b-4673-b1b2-f8a164118b58", "name": "Create synonym set", "request": { "name": "Create synonym set", "description": { "content": "Create a new synonym set.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2119280c-ec9c-4e98-99bd-927fbf3ba181", "name": "Successfully created synonym set", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n },\n \"meta\": {\n \"created_at\": \"2026-03-05T12:00:00Z\",\n \"updated_at\": \"2026-03-05T12:00:00Z\",\n \"owner\": \"organization\",\n \"sync_status\": \"pending_sync\",\n \"last_synced_at\": \"2026-03-05T12:01:00Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09c5ba2b-639b-41e7-95ce-6d658f4610d0", "name": "Bad request - invalid parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48c9eef6-69f5-470e-b028-8a0fa8a69417", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8adac3c0-b3ef-4a82-9a40-847b991bd4ad", "name": "List synonym sets", "request": { "name": "List synonym sets", "description": { "content": "List all synonym sets.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "811ed92a-a43c-4955-9ac9-2fc5f19a6e2e", "name": "Successfully listed synonym sets", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets" ], "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" } ], "body": "{\n \"data\": [\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n },\n \"meta\": {\n \"created_at\": \"2026-03-05T12:00:00Z\",\n \"updated_at\": \"2026-03-05T12:00:00Z\",\n \"owner\": \"organization\",\n \"sync_status\": \"pending_sync\",\n \"last_synced_at\": \"2026-03-05T12:01:00Z\"\n }\n },\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n },\n \"meta\": {\n \"created_at\": \"2026-03-05T12:00:00Z\",\n \"updated_at\": \"2026-03-05T12:00:00Z\",\n \"owner\": \"organization\",\n \"sync_status\": \"pending_sync\",\n \"last_synced_at\": \"2026-03-05T12:01:00Z\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 100\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a6dc1d4-03d7-4984-a372-63967d686e45", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "339ba674-573c-4ab3-a1fb-68c903f91b55", "name": "Get synonym set", "request": { "name": "Get synonym set", "description": { "content": "Get a synonym set by ID.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id", "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c894fc9e-5c91-4346-8467-c1eed5921290", "name": "Successfully retrieved synonym set", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id" } ] }, "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 \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n },\n \"meta\": {\n \"created_at\": \"2026-03-05T12:00:00Z\",\n \"updated_at\": \"2026-03-05T12:00:00Z\",\n \"owner\": \"organization\",\n \"sync_status\": \"pending_sync\",\n \"last_synced_at\": \"2026-03-05T12:01:00Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a3d3b7a-df6a-4ba2-83e9-5cea627dba4f", "name": "Synonym set not found", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id" } ] }, "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 \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71600332-2a08-42e6-a709-8740c0986c2a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99aa766c-4cf9-439b-99f8-0ba349765ece", "name": "Update synonym set", "request": { "name": "Update synonym set", "description": { "content": "Update a synonym set by ID.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id", "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "df3a6673-6c68-4d35-985b-c1c15774cc90", "name": "Successfully updated synonym set", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id" } ] }, "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 \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\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 \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n },\n \"meta\": {\n \"created_at\": \"2026-03-05T12:00:00Z\",\n \"updated_at\": \"2026-03-05T12:00:00Z\",\n \"owner\": \"organization\",\n \"sync_status\": \"pending_sync\",\n \"last_synced_at\": \"2026-03-05T12:01:00Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3666971e-e272-4706-a755-2e48a4545220", "name": "Bad request - invalid parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id" } ] }, "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 \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cbfd49b-b000-46ce-9e30-7e205ac9b9e9", "name": "Permission denied", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id" } ] }, "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 \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bbdb776-2106-40f6-8dd2-c3f587c24939", "name": "Synonym set not found", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id" } ] }, "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 \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09cd78f9-517d-431e-bf45-7b46be571ef4", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id" } ] }, "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 \"data\": {\n \"id\": \"8fccaa19-dba9-4621-8d11-31a222a68c7c\",\n \"type\": \"catalog_search_synonym_set\",\n \"attributes\": {\n \"name\": \"Apparel terms\",\n \"items\": [\n {\n \"id\": \"footwear-terms\",\n \"synonyms\": [\n \"sneakers\",\n \"trainers\",\n \"running shoes\"\n ],\n \"root\": \"jacket\",\n \"locale\": \"en\",\n \"symbols_to_index\": [\n \"-\"\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41a98031-e3fb-47ea-abdd-bec1b772eec3", "name": "Delete synonym set", "request": { "name": "Delete synonym set", "description": { "content": "Delete a synonym set by ID. A synonym set cannot be deleted while it is being used by any search profile.", "type": "text/plain" }, "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id", "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "da816ed1-9c35-473e-ad2d-e21281eac6d7", "name": "Synonym set marked for deletion", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id" } ] }, "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": "4cb37bcb-9d68-4a37-8922-c7186fc9b955", "name": "Bad request - invalid parameters", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a5796bc-e922-4fc6-bd0b-8d9e3e9414d9", "name": "Permission denied", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id" } ] }, "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 \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8828d4a-060e-4a76-b603-e710095735bd", "name": "Conflict - synonym set is referenced by a search profile", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id" } ] }, "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 \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n },\n {\n \"status\": \"500\",\n \"title\": \"Internal server error\",\n \"detail\": \"An internal error has occurred.\",\n \"meta\": {\n \"missing_ids\": [\n \"e7d50bd5-1833-43c0-9848-f9d325b08be8\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6407bbcb-90bc-411c-bef0-919a0c68c01c", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "catalogs", "search", "synonym-sets", ":synonym_set_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique ID of the synonym set", "type": "text/plain" }, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440000", "key": "synonym_set_id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Cart Management", "description": "A Cart contains the product and custom cart items that a user intends to purchase. After a Cart is ready for Checkout, you can use the [Checkout endpoint](/docs/api/carts/checkout) to convert the cart to an order.\n\n:::note\n\n- Adding, modifying, or removing any cart items, custom items, or promotions always returns the cart meta, calculated using the calculation method. This is useful to update the client with up-to-date totals.\n- We will automatically delete carts 7 days after they were last updated.\n- If you do not pass a `X-MOLTIN-CURRENCY` header specifying what currency you would like the cart to use, the products in the cart are converted to your default currency.\n\n:::\n", "item": [ { "id": "8c071034-c3e0-4ff3-858d-be94a9c356c8", "name": "Get Carts", "request": { "name": "Get Carts", "description": { "content": "Retrieves a list of carts. The carts returned depend on the authentication method used:\n\n| Authentication Method | Header | Returns |\n| :--- | :--- | :--- |\n| **Customer Token** | `X-Moltin-Customer-Token` | Carts for the specified customer. See [Customer Tokens](/docs/customer-management/customer-management-api/customer-tokens). |\n| **Account Token** | `EP-Account-Management-Authentication-Token` | Carts for the specified account. See [Account Management Token](/docs/api/accounts/post-v-2-account-members-tokens). |\n| **Client Credentials** | `Authorization: Bearer ` | All carts or only registered carts, controlled by the `show_all_carts` setting. See [Cart Settings](/docs/api/carts/put-v-2-settings-cart). |\n\n**Client Credentials Behavior:**\n- When `show_all_carts` is `true`: Returns all carts in the store.\n- When `show_all_carts` is `false`: Returns only registered carts (associated with customers or accounts).\n\n**Sorting**\n\nCarts are sorted in descending order by `updated_date`. For more information, see [Pagination](/guides/Getting-Started/pagination).\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "custom_discounts" }, { "disabled": false, "description": { "content": "The maximum number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "20" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Filter expression for searching carts. For more information about filtering, see [Filtering](/guides/Getting-Started/filtering).\n\n**Supported Fields:**\n- `account_ids`: Filter carts by associated account ID (UUID format)\n- `name`: Filter carts by cart name (case-insensitive)\n\n**Supported Operators:**\n- `contains(field,value)`: Contains value in array field\n- `ilike(field,value)`: Case-insensitive string matching\n\n**Examples:**\n- `contains(account_ids,\"c24e5698-3b54-491b-9225-559c7a9cf2b2\")` - Find carts associated with a specific account\n- `ilike(name,\"Shopping Cart\")` - Find carts with name matching \"Shopping Cart\" (case-insensitive)\n- `ilike(name,\"*cart*\")` - Find carts with names containing \"cart\" (wildcard search)\n\n**Combining Filters:**\nYou can combine multiple filters using the `:`, and `|` operator for and and or respectively:\n- `contains(account_ids,\"abc123\"):ilike(name,\"Holiday Cart\")` - Find carts matching both conditions\n- `contains(account_ids,\"abc123\")|ilike(name,\"Holiday Cart\")` - Find carts matching either condition.\n", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6200b572-22e5-4fdd-ac53-7d7329dc3d8b", "name": "200", "originalRequest": { "url": { "path": [ "v2", "carts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "custom_discounts" }, { "disabled": false, "description": { "content": "The maximum number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "20" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Filter expression for searching carts. For more information about filtering, see [Filtering](/guides/Getting-Started/filtering).\n\n**Supported Fields:**\n- `account_ids`: Filter carts by associated account ID (UUID format)\n- `name`: Filter carts by cart name (case-insensitive)\n\n**Supported Operators:**\n- `contains(field,value)`: Contains value in array field\n- `ilike(field,value)`: Case-insensitive string matching\n\n**Examples:**\n- `contains(account_ids,\"c24e5698-3b54-491b-9225-559c7a9cf2b2\")` - Find carts associated with a specific account\n- `ilike(name,\"Shopping Cart\")` - Find carts with name matching \"Shopping Cart\" (case-insensitive)\n- `ilike(name,\"*cart*\")` - Find carts with names containing \"cart\" (wildcard search)\n\n**Combining Filters:**\nYou can combine multiple filters using the `:`, and `|` operator for and and or respectively:\n- `contains(account_ids,\"abc123\"):ilike(name,\"Holiday Cart\")` - Find carts matching both conditions\n- `contains(account_ids,\"abc123\")|ilike(name,\"Holiday Cart\")` - Find carts matching either condition.\n", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "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\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"contact\": {\n \"email\": \"ENXqzF8@kJXyCFTSikbrwZbTGiLdhtjrAQh.rjej\"\n },\n \"discount_settings\": {\n \"custom_discounts_enabled\": true,\n \"use_rule_promotions\": true\n },\n \"inventory_settings\": {\n \"defer_inventory_check\": false\n },\n \"item_settings\": {\n \"separate_items_by_location\": true\n },\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"boolean\",\n \"value\": true\n }\n },\n \"snapshot_date\": \"1951-04-02T02:10:51.812Z\",\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 637.6907531326759,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 9000.097376735332,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 3609.7535589847653,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 7713.5020899648525,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 8444.209308327663,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 8544.027118984835,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 3904.321365307968,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"expires_at\": \"string\"\n },\n \"promotion_suggestions\": [\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 6809,\n \"targets\": [\n \"string\",\n \"string\"\n ],\n \"key_0\": 8368\n },\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 7522,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n },\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 1380,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 2882,\n \"targets\": [\n \"string\",\n \"string\"\n ],\n \"key_0\": \"string\"\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n }\n ]\n },\n \"relationships\": {\n \"customers\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"f283ac40-4343-82f0-4ace-4c03e466a961\"\n },\n {\n \"type\": \"string\",\n \"id\": \"148e99d6-22bb-3902-a6ed-eeb65a7d91c3\"\n }\n ]\n },\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"8e6bc076-2d53-12a7-a41f-6209744335a0\"\n },\n {\n \"type\": \"string\",\n \"id\": \"8b266471-38b1-d283-6967-b4bbc38fb44d\"\n }\n ]\n },\n \"accounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"a8760697-6eea-7f14-9368-3a85f4f93c45\"\n },\n {\n \"type\": \"string\",\n \"id\": \"4b4262e0-049a-add0-18c6-14584f238aea\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"f43cfd3f-b2b4-98b1-3669-10189f1b789c\"\n },\n {\n \"type\": \"string\",\n \"id\": \"b190c580-fe91-20fa-589b-1ab366885c58\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"f53d2bfe-a1b0-63bb-bd09-23992234adad\"\n },\n {\n \"type\": \"string\",\n \"id\": \"a476cac1-6c90-0617-96e6-921ea445b717\"\n }\n ]\n }\n },\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"contact\": {\n \"email\": \"yBI36EUPQhhsoG@wYhtTMZBZMHNrzPYWNRYBmc.yma\"\n },\n \"discount_settings\": {\n \"custom_discounts_enabled\": true,\n \"use_rule_promotions\": false\n },\n \"inventory_settings\": {\n \"defer_inventory_check\": true\n },\n \"item_settings\": {\n \"separate_items_by_location\": false\n },\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": 7759.779785766905\n }\n },\n \"snapshot_date\": \"2011-10-31T15:17:44.522Z\",\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 6005.607932553569,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 6009.605992421579,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 5283.331149921124,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 7105.211446454987,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 3049.7390567548923,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 4227.927187619094,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 384.0287340128934,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"expires_at\": \"string\"\n },\n \"promotion_suggestions\": [\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 7193,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 7915,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n },\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 8531,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 5557,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n }\n ]\n },\n \"relationships\": {\n \"customers\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"40bd251c-4759-acd8-49d9-a7f3a898e5de\"\n },\n {\n \"type\": \"string\",\n \"id\": \"48f17d15-b149-8d2c-37c0-3ae9720e84fb\"\n }\n ]\n },\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"8f1f2cc7-60fd-a425-e998-4b2617400e27\"\n },\n {\n \"type\": \"string\",\n \"id\": \"5a5937ef-0497-cc78-4694-a49cc5a7ea55\"\n }\n ]\n },\n \"accounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"169dc6db-5d75-6c47-e907-33ffd431e308\"\n },\n {\n \"type\": \"string\",\n \"id\": \"5f057dbe-15f8-4faf-11e6-4551e01f1418\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"10eca348-b325-6a9e-116b-735de4c502f7\"\n },\n {\n \"type\": \"string\",\n \"id\": \"86c7117f-7499-b4f2-f44e-c15e8fda841e\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"e370a29a-120d-07f9-9f31-02723b6b0733\"\n },\n {\n \"type\": \"string\",\n \"id\": \"34b122e2-75c4-64c2-c701-7744f41b2c34\"\n }\n ]\n }\n },\n \"type\": \"string\"\n }\n ],\n \"links\": {\n \"current\": \"string\",\n \"first\": \"string\",\n \"last\": \"string\",\n \"next\": \"string\",\n \"prev\": \"string\"\n },\n \"meta\": {\n \"page\": {\n \"current\": 6366,\n \"limit\": 9414,\n \"offset\": 3723,\n \"total\": 4236\n },\n \"results\": {\n \"total\": 3384\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31ec6f48-6808-4256-9cba-30798a9a2716", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "custom_discounts" }, { "disabled": false, "description": { "content": "The maximum number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "20" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Filter expression for searching carts. For more information about filtering, see [Filtering](/guides/Getting-Started/filtering).\n\n**Supported Fields:**\n- `account_ids`: Filter carts by associated account ID (UUID format)\n- `name`: Filter carts by cart name (case-insensitive)\n\n**Supported Operators:**\n- `contains(field,value)`: Contains value in array field\n- `ilike(field,value)`: Case-insensitive string matching\n\n**Examples:**\n- `contains(account_ids,\"c24e5698-3b54-491b-9225-559c7a9cf2b2\")` - Find carts associated with a specific account\n- `ilike(name,\"Shopping Cart\")` - Find carts with name matching \"Shopping Cart\" (case-insensitive)\n- `ilike(name,\"*cart*\")` - Find carts with names containing \"cart\" (wildcard search)\n\n**Combining Filters:**\nYou can combine multiple filters using the `:`, and `|` operator for and and or respectively:\n- `contains(account_ids,\"abc123\"):ilike(name,\"Holiday Cart\")` - Find carts matching both conditions\n- `contains(account_ids,\"abc123\")|ilike(name,\"Holiday Cart\")` - Find carts matching either condition.\n", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed35bda4-8506-46e0-86bc-df7eab96c292", "name": "Unauthorized call", "originalRequest": { "url": { "path": [ "v2", "carts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "custom_discounts" }, { "disabled": false, "description": { "content": "The maximum number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "20" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Filter expression for searching carts. For more information about filtering, see [Filtering](/guides/Getting-Started/filtering).\n\n**Supported Fields:**\n- `account_ids`: Filter carts by associated account ID (UUID format)\n- `name`: Filter carts by cart name (case-insensitive)\n\n**Supported Operators:**\n- `contains(field,value)`: Contains value in array field\n- `ilike(field,value)`: Case-insensitive string matching\n\n**Examples:**\n- `contains(account_ids,\"c24e5698-3b54-491b-9225-559c7a9cf2b2\")` - Find carts associated with a specific account\n- `ilike(name,\"Shopping Cart\")` - Find carts with name matching \"Shopping Cart\" (case-insensitive)\n- `ilike(name,\"*cart*\")` - Find carts with names containing \"cart\" (wildcard search)\n\n**Combining Filters:**\nYou can combine multiple filters using the `:`, and `|` operator for and and or respectively:\n- `contains(account_ids,\"abc123\"):ilike(name,\"Holiday Cart\")` - Find carts matching both conditions\n- `contains(account_ids,\"abc123\")|ilike(name,\"Holiday Cart\")` - Find carts matching either condition.\n", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "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 \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e0ae4fd0-85e3-43d2-8787-b2cebed22c83", "name": "Create a Cart", "request": { "name": "Create a Cart", "description": { "content": "\nCreates a cart. Call this endpoint each time a customer creates a cart.\n\nEach shopper can have multiple carts. Use the carts API to create a cart. The carts are distinct from one another. Shoppers can add different items to their carts. They can check out one of the carts without affecting the content or status of their other carts.\n\nAfter the shopper checks out the cart, the cart remains available to the shopper. The cart is persistent and stays with the shopper after it is used.\n\nYou can create a cart to specify custom discounts. You can enable custom discounts when the `discount_settings.custom_discounts_enabled` field is set to `true`. Default is set from cart discount settings for the store. See [Update Cart Settings](/docs/api/carts/put-v-2-settings-cart).\n\nYou can also create a cart when inventory checks are not performed until checkout by setting the `inventory_settings.defer_inventory_check` field to `true`. Again the default is set from cart discount settings for the store. See [Update Cart Settings](/docs/api/carts/put-v-2-settings-cart).\n\n### Preview Cart\n\nYou can set a future date for your shopping cart and view the promotions that will be available during that time period. This feature enables you to validate your promotion settings and observe how they will be applied in the cart.\n\n:::caution\n- Once the cart is in preview mode, you cannot revert it to a regular cart.\n- Carts with `snapshot_date` are same as preview carts.\n- You cannot checkout a cart that includes a `snapshot_date`.\n- To delete a promotion preview cart, use [Delete a cart](/docs/api/carts/delete-a-cart) endpoint.\n- The promotion preview cart has the same expiration time as a regular cart based on the store's [cart settings](/docs/api/carts/put-v-2-settings-cart).\n- Preview cart interactions skip inventory checks and events, allowing users to preview future carts without impacting related external systems.\n:::\n\n### Custom Attributes\nYou can create custom attributes for the cart object to include additional information, enabling promotions that target specific cart attributes.\nFor example:\n```\n\"custom_attributes\":{\n \"membership\": {\n \"type\": \"string\",\n \"value\": \"VIP\"\n }\n}\n```\nSee [adding cart custom attributes in promotions builder](/docs/commerce-manager/promotions-builder/creating-a-promotion-in-promotions-builder#adding-cart-custom-attributes)\n\nCart custom attributes remain with the corresponding cart for the extent of its lifecycle. These custom attributes carry over to the resulting order objects on checkout and those on carts are deleted with their carts upon cart deletions.\nCustom attributes can be updated or removed using a PUT request. To delete specific custom attributes, simply exclude the unwanted attribute objects from the PUT request body.\n\n### Contact Email\nYou can attach an email to carts via the `contact.email` field. These values help identify guest shopper carts and, in the case of promotions with maximum usage settings for guest and registered shopper, track per-shopper promotion usages.\nSee [Create Max Uses Per Shopper Promotion Codes](/docs/promotions-builder/promotions-builder-codes/create-max-use-limit-promotion-codes)\n\nFor example:\n```\n\"contact\": {\n \"email\": \"tester@email.com\"\n}\n```\n\nPlease note, this value is not supported for registered shopper carts (that is, carts with accounts or customers associated), as these carts already have email values associated via the shopper details. Accordingly, requests to add contact email information to registered shopper carts (and vice versa) result in error messages.\n\n### Errors\n\n- `400 Bad Request` : This is returned when the submitted request does not adhere to the expected API contract for the endpoint.\n\n - For example, in the case of string fields, this error might indicate issues in the length or format of submitted strings. For more information about valid string fields, refer to Safe Characters section.\n - In the case of preview carts (those with `snapshot_date`), an error is returned for invalid actions, such as removing the preview date, setting a preview date in the past, or attempting to checkout a cart with a `snapshot_date`.\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token for the account to be associated with the cart.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "disabled": false, "description": { "content": "A customer token for the customer to be associated with the cart.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"name\": \"Bob's cart\",\n \"description\": \"For Holidays\",\n \"discount_settings\": {\n \"custom_discounts_enabled\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4f5da5cc-de9f-453d-ba30-27b337f581d8", "name": "201", "originalRequest": { "url": { "path": [ "v2", "carts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token for the account to be associated with the cart.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "disabled": false, "description": { "content": "A customer token for the customer to be associated with the cart.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "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 \"data\": {\n \"name\": \"Bob's cart\",\n \"description\": \"For Holidays\",\n \"discount_settings\": {\n \"custom_discounts_enabled\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"contact\": {\n \"email\": \"xeDXFzKwAyR@NFU.edl\"\n },\n \"discount_settings\": {\n \"custom_discounts_enabled\": true,\n \"use_rule_promotions\": false\n },\n \"inventory_settings\": {\n \"defer_inventory_check\": false\n },\n \"item_settings\": {\n \"separate_items_by_location\": true\n },\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": 5799.183081697556\n },\n \"key_1\": {\n \"type\": \"integer\",\n \"value\": true\n },\n \"key_2\": {\n \"type\": \"float\",\n \"value\": 6605.193068470192\n }\n },\n \"snapshot_date\": \"1984-05-08T11:16:27.262Z\",\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8335.403926465655,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 4521.2827265191445,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 1097.22823427588,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 5353.789609953707,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 9179.612124743386,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 1310.4079749712016,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 5450.502653055869,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"expires_at\": \"string\"\n },\n \"promotion_suggestions\": [\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 1268,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 5762,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n },\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 6425,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 6345,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n }\n ]\n },\n \"relationships\": {\n \"customers\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"00c38ee6-a1ad-f92e-c207-466e418faf04\"\n },\n {\n \"type\": \"string\",\n \"id\": \"b71ccf30-6c9d-1dd6-7702-02110fbde8ca\"\n }\n ]\n },\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"d9e07c05-8b8f-8b73-0bf3-f387e5a54ec6\"\n },\n {\n \"type\": \"string\",\n \"id\": \"6919c16a-323d-3efd-436f-739e234d3ebb\"\n }\n ]\n },\n \"accounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"e6494c38-1c85-1612-aa4f-84d6640d48df\"\n },\n {\n \"type\": \"string\",\n \"id\": \"1e134a7e-210e-9b2d-e2cd-8af245c58ac4\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"ddddd9de-ad63-6bc0-6a93-de7a98057d60\"\n },\n {\n \"type\": \"string\",\n \"id\": \"fccca761-c8e3-88d9-cecf-f0897a954631\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"a3e5dcd5-682e-3ff1-4491-8864173fe9f2\"\n },\n {\n \"type\": \"string\",\n \"id\": \"e0fb42e6-aa73-e142-9201-5b9ae96bcd56\"\n }\n ]\n }\n },\n \"type\": \"string\"\n },\n \"included\": {\n \"custom_discounts\": [\n {\n \"type\": \"string\",\n \"id\": \"5c42e1a9-d3e1-5c87-604c-d2038b9e57d4\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 1177.2432667943278,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"31585381-e220-14a0-dfd2-8fc359b36761\",\n \"type\": \"cart_item\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"1a5e5206-ba1e-90d8-4c62-35c9197aae1a\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 6500.5931659885355,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"1a80d140-0544-6cb0-a5b6-92c2bb463fde\",\n \"type\": \"cart_item\"\n }\n }\n }\n }\n ],\n \"promotions\": [\n {\n \"type\": \"string\",\n \"id\": \"edc03c37-d6b1-4d48-e417-a55441ee68ea\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1964-08-16T03:07:46.846Z\",\n \"end\": \"1961-07-21T03:04:33.803Z\"\n },\n {\n \"type\": \"string\",\n \"id\": \"6a9e94c9-373c-4b08-c235-0b01eadbb578\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": true,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1968-09-23T14:15:29.513Z\",\n \"end\": \"1979-10-14T14:46:20.220Z\"\n }\n ]\n },\n \"meta\": {\n \"payment_intent\": {\n \"key_0\": true,\n \"key_1\": 6015,\n \"key_2\": 3149.423768778801\n }\n },\n \"errors\": [\n {\n \"status\": 9866,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"Pt-CPET-v@vJobjBjFIPEZLoXjoE.ey\",\n \"component_product_id\": \"59f7cde3-4669-4e28-750b-e0a37d3a31e7\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 2437,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"PeE-KXwTfA50@ONyIrEaZmHqVdVkhf.vnp\",\n \"component_product_id\": \"d9548207-f7f4-8a7c-0f51-be17158f2590\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f6517f1-0ad9-49cd-96f6-dd7e4e142267", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token for the account to be associated with the cart.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "disabled": false, "description": { "content": "A customer token for the customer to be associated with the cart.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "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 \"data\": {\n \"name\": \"Bob's cart\",\n \"description\": \"For Holidays\",\n \"discount_settings\": {\n \"custom_discounts_enabled\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b613bdf-de43-438e-9b38-2279dc2e1040", "name": "Unauthorized call", "originalRequest": { "url": { "path": [ "v2", "carts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token for the account to be associated with the cart.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "disabled": false, "description": { "content": "A customer token for the customer to be associated with the cart.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "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 \"data\": {\n \"name\": \"Bob's cart\",\n \"description\": \"For Holidays\",\n \"discount_settings\": {\n \"custom_discounts_enabled\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f661eb4-399d-4aee-b655-e0dad8cd73dc", "name": "Get a Cart", "request": { "name": "Get a Cart", "description": { "content": "Use this endpoint to retrieve a specific cart. If a cart ID does not exist, a new cart will be automatically created. If the cart is associated with shipping groups, calling this endpoint displays the associated shipping group IDs in the `relationships` section.\n\nYou can easily get a new or existing cart by providing the unique cart reference in the request. If the cart is associated with shipping groups, calling this endpoint displays the associated shipping group IDs in the relationships section.\n\n:::note\n\n- The default cart name is Cart. However, you can update the cart name as required. Ensure that the string length of the name is greater than or equal to one. Follow the safe character guidelines for name and description naming. For more information about cart ID naming requirements, see the [Safe Characters](/guides/Getting-Started/safe-characters) section.\n- Outside of the JS-SDK, we don't handle creating cart references. You need to create your own.\n\n:::\n\n:::caution\n\nAn empty cart is returned for any carts that don't currently exist. For more information about the cart items object, see [Get Cart Items](/docs/api/carts/get-cart-items).\n\n:::\n\n### Query parameters\n\n\n| Name | Required | Type | Description |\n|:----------|:---------|:---------|:-------------------------------------------|\n| `include` | Optional | `string` | Comma-delimited string of entities that can be included. The information included are `items`,`tax_items`, `custom_discounts`, or `promotions`. |\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "custom_discounts" } ], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier for this cart that you created.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "aa3be953-59f3-4b7e-8288-891131545411", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "custom_discounts" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier for this cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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 \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"contact\": {\n \"email\": \"xeDXFzKwAyR@NFU.edl\"\n },\n \"discount_settings\": {\n \"custom_discounts_enabled\": true,\n \"use_rule_promotions\": false\n },\n \"inventory_settings\": {\n \"defer_inventory_check\": false\n },\n \"item_settings\": {\n \"separate_items_by_location\": true\n },\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": 5799.183081697556\n },\n \"key_1\": {\n \"type\": \"integer\",\n \"value\": true\n },\n \"key_2\": {\n \"type\": \"float\",\n \"value\": 6605.193068470192\n }\n },\n \"snapshot_date\": \"1984-05-08T11:16:27.262Z\",\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8335.403926465655,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 4521.2827265191445,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 1097.22823427588,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 5353.789609953707,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 9179.612124743386,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 1310.4079749712016,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 5450.502653055869,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"expires_at\": \"string\"\n },\n \"promotion_suggestions\": [\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 1268,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 5762,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n },\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 6425,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 6345,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n }\n ]\n },\n \"relationships\": {\n \"customers\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"00c38ee6-a1ad-f92e-c207-466e418faf04\"\n },\n {\n \"type\": \"string\",\n \"id\": \"b71ccf30-6c9d-1dd6-7702-02110fbde8ca\"\n }\n ]\n },\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"d9e07c05-8b8f-8b73-0bf3-f387e5a54ec6\"\n },\n {\n \"type\": \"string\",\n \"id\": \"6919c16a-323d-3efd-436f-739e234d3ebb\"\n }\n ]\n },\n \"accounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"e6494c38-1c85-1612-aa4f-84d6640d48df\"\n },\n {\n \"type\": \"string\",\n \"id\": \"1e134a7e-210e-9b2d-e2cd-8af245c58ac4\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"ddddd9de-ad63-6bc0-6a93-de7a98057d60\"\n },\n {\n \"type\": \"string\",\n \"id\": \"fccca761-c8e3-88d9-cecf-f0897a954631\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"a3e5dcd5-682e-3ff1-4491-8864173fe9f2\"\n },\n {\n \"type\": \"string\",\n \"id\": \"e0fb42e6-aa73-e142-9201-5b9ae96bcd56\"\n }\n ]\n }\n },\n \"type\": \"string\"\n },\n \"included\": {\n \"custom_discounts\": [\n {\n \"type\": \"string\",\n \"id\": \"5c42e1a9-d3e1-5c87-604c-d2038b9e57d4\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 1177.2432667943278,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"31585381-e220-14a0-dfd2-8fc359b36761\",\n \"type\": \"cart_item\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"1a5e5206-ba1e-90d8-4c62-35c9197aae1a\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 6500.5931659885355,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"1a80d140-0544-6cb0-a5b6-92c2bb463fde\",\n \"type\": \"cart_item\"\n }\n }\n }\n }\n ],\n \"promotions\": [\n {\n \"type\": \"string\",\n \"id\": \"edc03c37-d6b1-4d48-e417-a55441ee68ea\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1964-08-16T03:07:46.846Z\",\n \"end\": \"1961-07-21T03:04:33.803Z\"\n },\n {\n \"type\": \"string\",\n \"id\": \"6a9e94c9-373c-4b08-c235-0b01eadbb578\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": true,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1968-09-23T14:15:29.513Z\",\n \"end\": \"1979-10-14T14:46:20.220Z\"\n }\n ]\n },\n \"meta\": {\n \"payment_intent\": {\n \"key_0\": true,\n \"key_1\": 6015,\n \"key_2\": 3149.423768778801\n }\n },\n \"errors\": [\n {\n \"status\": 9866,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"Pt-CPET-v@vJobjBjFIPEZLoXjoE.ey\",\n \"component_product_id\": \"59f7cde3-4669-4e28-750b-e0a37d3a31e7\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 2437,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"PeE-KXwTfA50@ONyIrEaZmHqVdVkhf.vnp\",\n \"component_product_id\": \"d9548207-f7f4-8a7c-0f51-be17158f2590\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8d8c3b9-383a-4f42-85b1-a672cb5c1e99", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "custom_discounts" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier for this cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "713634b3-3a60-482f-b92e-9464da850f9c", "name": "Update a Cart", "request": { "name": "Update a Cart", "description": { "content": "Updates cart properties for the specified cartID.\n\nYou can update a cart to specify custom discounts. You can enable custom discounts when the `discount_settings.custom_discounts_enabled` field is set to `true`. Default is set from cart discount settings for the store. See [Cart Settings](/docs/api/carts/put-v-2-settings-cart).\n\nYou can also create a cart when inventory checks are not performed until checkout by setting the `inventory_settings.defer_inventory_check` field to `true`. Again the default is set from cart discount settings for the store. See [Update Cart Settings](/docs/api/carts/put-v-2-settings-cart).\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of a cart created by you.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"name\": \"my cart\",\n \"description\": \"my first cart\",\n \"discount_settings\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": true\n },\n \"snapshot_date\": \"2026-09-10T00:12:00Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7d31eaa8-4374-4f1e-b1a2-c00c0278e47e", "name": "200", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a cart created by you.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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 \"data\": {\n \"name\": \"my cart\",\n \"description\": \"my first cart\",\n \"discount_settings\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": true\n },\n \"snapshot_date\": \"2026-09-10T00:12:00Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"contact\": {\n \"email\": \"xeDXFzKwAyR@NFU.edl\"\n },\n \"discount_settings\": {\n \"custom_discounts_enabled\": true,\n \"use_rule_promotions\": false\n },\n \"inventory_settings\": {\n \"defer_inventory_check\": false\n },\n \"item_settings\": {\n \"separate_items_by_location\": true\n },\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": 5799.183081697556\n },\n \"key_1\": {\n \"type\": \"integer\",\n \"value\": true\n },\n \"key_2\": {\n \"type\": \"float\",\n \"value\": 6605.193068470192\n }\n },\n \"snapshot_date\": \"1984-05-08T11:16:27.262Z\",\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8335.403926465655,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 4521.2827265191445,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 1097.22823427588,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 5353.789609953707,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 9179.612124743386,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 1310.4079749712016,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 5450.502653055869,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"expires_at\": \"string\"\n },\n \"promotion_suggestions\": [\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 1268,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 5762,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n },\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 6425,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 6345,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n }\n ]\n },\n \"relationships\": {\n \"customers\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"00c38ee6-a1ad-f92e-c207-466e418faf04\"\n },\n {\n \"type\": \"string\",\n \"id\": \"b71ccf30-6c9d-1dd6-7702-02110fbde8ca\"\n }\n ]\n },\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"d9e07c05-8b8f-8b73-0bf3-f387e5a54ec6\"\n },\n {\n \"type\": \"string\",\n \"id\": \"6919c16a-323d-3efd-436f-739e234d3ebb\"\n }\n ]\n },\n \"accounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"e6494c38-1c85-1612-aa4f-84d6640d48df\"\n },\n {\n \"type\": \"string\",\n \"id\": \"1e134a7e-210e-9b2d-e2cd-8af245c58ac4\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"ddddd9de-ad63-6bc0-6a93-de7a98057d60\"\n },\n {\n \"type\": \"string\",\n \"id\": \"fccca761-c8e3-88d9-cecf-f0897a954631\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"a3e5dcd5-682e-3ff1-4491-8864173fe9f2\"\n },\n {\n \"type\": \"string\",\n \"id\": \"e0fb42e6-aa73-e142-9201-5b9ae96bcd56\"\n }\n ]\n }\n },\n \"type\": \"string\"\n },\n \"included\": {\n \"custom_discounts\": [\n {\n \"type\": \"string\",\n \"id\": \"5c42e1a9-d3e1-5c87-604c-d2038b9e57d4\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 1177.2432667943278,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"31585381-e220-14a0-dfd2-8fc359b36761\",\n \"type\": \"cart_item\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"1a5e5206-ba1e-90d8-4c62-35c9197aae1a\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 6500.5931659885355,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"1a80d140-0544-6cb0-a5b6-92c2bb463fde\",\n \"type\": \"cart_item\"\n }\n }\n }\n }\n ],\n \"promotions\": [\n {\n \"type\": \"string\",\n \"id\": \"edc03c37-d6b1-4d48-e417-a55441ee68ea\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1964-08-16T03:07:46.846Z\",\n \"end\": \"1961-07-21T03:04:33.803Z\"\n },\n {\n \"type\": \"string\",\n \"id\": \"6a9e94c9-373c-4b08-c235-0b01eadbb578\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": true,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1968-09-23T14:15:29.513Z\",\n \"end\": \"1979-10-14T14:46:20.220Z\"\n }\n ]\n },\n \"meta\": {\n \"payment_intent\": {\n \"key_0\": true,\n \"key_1\": 6015,\n \"key_2\": 3149.423768778801\n }\n },\n \"errors\": [\n {\n \"status\": 9866,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"Pt-CPET-v@vJobjBjFIPEZLoXjoE.ey\",\n \"component_product_id\": \"59f7cde3-4669-4e28-750b-e0a37d3a31e7\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 2437,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"PeE-KXwTfA50@ONyIrEaZmHqVdVkhf.vnp\",\n \"component_product_id\": \"d9548207-f7f4-8a7c-0f51-be17158f2590\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9062548-c7a2-4d7f-9166-52bdd43a6a93", "name": "Unauthorized call", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a cart created by you.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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 \"data\": {\n \"name\": \"my cart\",\n \"description\": \"my first cart\",\n \"discount_settings\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": true\n },\n \"snapshot_date\": \"2026-09-10T00:12:00Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e851bdf9-d893-4acc-819d-5dbb0035d164", "name": "Unprocessable Content", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a cart created by you.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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 \"data\": {\n \"name\": \"my cart\",\n \"description\": \"my first cart\",\n \"discount_settings\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": true\n },\n \"snapshot_date\": \"2026-09-10T00:12:00Z\"\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 \"status\": 6354,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"uMZg@yJCtsAFOpbHpExhqXaaZScCsBH.ra\",\n \"component_product_id\": \"b3f01bed-2c1b-156a-c4b8-ef0b73c26cfe\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c1b75882-4d48-4d66-8dce-89e0226c11a4", "name": "Delete a Cart", "request": { "name": "Delete a Cart", "description": { "content": "You can delete a cart, including the items, name, description, and remove all associations.\n\n### Errors\n\nThe following error message is received when you attempt to delete a cart that is associated with a customer. Before deletion, ensure that the cart is disassociated.\n\n```json\nmessage: {\n errors: [\n {\n status: 400,\n title: 'Last cart',\n detail: 'This is the last cart associated with a customer and it cannot be deleted, try disassociating instead'\n }\n ]\n }\n````\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you want to delete.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "2abfdfe5-e7ad-4aa6-844c-26d91e663681", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "8e25ccdb-d3e6-4a9e-ac6c-1c3f9c7c2764", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account Cart Associations", "description": "You can create associations between an account and one or more carts. After cart associations exist for an account, those carts are accessible across any device. You can delete associations as required.\n\nThere are two ways to access the cart: with an [Account Management Authentication Tokens](/docs/api/accounts/post-v-2-account-members-tokens) and without one.\n\n### With an `Account Management Authentication` token\n\nThese endpoints are for users who authenticated implicitly and require an Account Management Authentication token in the header to access the account cart associations APIs. For more information, see the [Account Token](/docs/api/accounts/post-v-2-account-members-tokens) documentation.\n\n#### Cart creation\n\nShoppers create carts and can use any of the carts that they created to check out an order.\n\n:::note\n\nYou can create a cart id, name, and description for the cart. The cart requires a name. Ensure that the string length is greater than or equal to one. Use any symbol in the name and description. For cart id, ensure that you follow the guidelines for safe characters. For more information about cart id naming requirements, see [Safe Characters](/guides/Getting-Started/safe-characters).\n\n:::\n\n### Without an `Account Management Authentication` token\n\nThese endpoints are for users who use the Client Credentials Token and do not require an account management authentication token in the header to access the account cart associations APIs. For more information, see the [Authentication](/docs/authentication/security) documentation.\n\nThis user acts as a system administrator and can call any account cart association operations for any account and cart.\n\n### Error Codes\n\nYou might encounter the following response codes, depending on the scenario:\n\n* `400` - `The type does not exist or is not listed as account` - Ensure that the type is `account` and is present.\n\n* `403` - `Cannot associate more than one account`.\n\n* `403` - `Account does not have the required permissions to fulfill this request`.\n\n* `403` - `Invalid json payload` - Check JSON input. The request body must be an array `[]`. If the request body is an object, the error is generated.\n", "item": [ { "id": "ae862132-ac6e-48d3-9775-d9f276c41d78", "name": "Create an Account Cart Association", "request": { "name": "Create an Account Cart Association", "description": { "content": "You can create associations between an account and one or more carts. After cart associations exist for an account, the account can access those carts across any device.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "relationships", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The ID for the cart created by the account. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e564b6c4-ff2d-4eaf-850b-f68bb387ea9d", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the account. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "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 \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\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\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d185e33a-02b7-418e-a0fc-33a45f56d89f", "name": "No Content is sent back in case the account has already been associated to the cart.", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the account. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "key": "Content-Type", "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 \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a5548e41-ad45-4009-944a-1054e850e2a6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the account. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "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 \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cafc3808-4d75-41dd-9e38-fb20994a1bbe", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the account. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "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 \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91899e71-3239-4070-abe2-32d64ed4c6c5", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the account. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "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 \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\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 \"errors\": [\n {\n \"detail\": \"Unable to associate accounts to carts with contact emails attached.\",\n \"status\": 400,\n \"title\": \"Cannot associate accounts to carts with contact emails\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f66f521-b09e-4b56-b682-cbb2e13ca92d", "name": "Delete Account Cart Association", "request": { "name": "Delete Account Cart Association", "description": { "content": "You can delete an association between an account and a cart.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "relationships", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The ID for the cart created by the account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9f185b4f-3d33-44c5-8f60-e34a5b2b4b8a", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the account.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b03a2a5f-6922-4e14-94ea-cf64ce366eae", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the account.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5221b2d-b2d7-4ab2-a572-b338cfba3a25", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the account.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "An Account Management Authentication token to access a specific account's carts.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Customer Cart Associations", "description": "You can create associations between a customer and one or more carts. After cart associations exist for a customer, those carts are accessible across any device. You can delete associations as required.\n\nThere are two ways to access the cart: with a customer token and without one.\n\n### With a `customer` token\n\nThese endpoints are for users who authenticated implicitly and require a customer token in the header to access the customer cart associations APIs. For more information, see the [Customer Token](/docs/customer-management/customer-management-api/customer-tokens) documentation.\n\n#### Cart creation\n\nShoppers create carts and can use any of the carts that they created to check out an order.\n\n:::note\n\nYou can create a cart id, name, and description for the cart. The cart requires a name. Ensure that the string length is greater than or equal to one. Use any symbol in the name and description. For cart id, ensure that you follow the guidelines for safe characters. For more information about cart id naming requirements, see [Safe Characters](/guides/Getting-Started/safe-characters).\n\n:::\n\n### Without a `customer` token\n\nThese endpoints are for users who use the Client Credentials Token and do not require a Customer token in the header to access the customer cart associations APIs. For more information, see the [Authentication](/docs/authentication/security) documentation.\n\nThis user acts as a system administrator and can call any customer cart association operations for any customer and cart.\n\n### Error Codes\n\nYou might encounter the following response codes, depending on the scenario:\n\n* `400` - `The type does not exist or is not listed as customer` - Ensure that the type is `customer` and is present.\n\n* `403` - `Cannot associate more than one customer`.\n\n* `403` - `Customer does not have the required permissions to fulfill this request`.\n\n* `403` - `Invalid json payload` - Check JSON input. The request body must be an array `[]`. If the request body is an object, the error is generated.\n", "item": [ { "id": "99a33793-5051-4350-af03-ac2b1d88524a", "name": "Create a Customer Cart Association", "request": { "name": "Create a Customer Cart Association", "description": { "content": "You can create associations between a customer and one or more carts. After cart associations exist for a customer, the customer can access those carts across any device.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "relationships", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The ID for the cart created by the customer. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6a4dad04-f308-4df3-9cc9-861064239be6", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the customer. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "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 \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\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\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "018612f1-704d-4b7e-9e7d-d887df50dae2", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the customer. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "key": "Content-Type", "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 \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b7abf4ac-ca34-4990-989d-545248730d98", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the customer. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "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 \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb6a0e48-29dc-46d7-8bc0-7ea7bbe1efdd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the customer. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "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 \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dd38e31-6742-4d05-b102-9c0393560a8b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the customer. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "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 \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\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 \"errors\": [\n {\n \"detail\": \"Unable to associate customers to carts with contact emails attached.\",\n \"status\": 400,\n \"title\": \"Cannot associate customers to carts with contact emails\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73317c74-917b-4bbe-97d2-7f43bec71964", "name": "Delete Customer Cart Association", "request": { "name": "Delete Customer Cart Association", "description": { "content": "You can delete an association between a customer and a cart.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "relationships", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The ID for the cart created by the customer.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ec764503-7d27-4c58-8564-9d894a5763d4", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the customer.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "94117b24-ad60-4d25-8ec2-ef03c6aa9d19", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the customer.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97927c53-fcdd-41be-a755-be54817723b6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "relationships", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the cart created by the customer.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "A customer token to access a specific customer's carts.", "type": "text/plain" }, "key": "X-Moltin-Customer-Token", "value": "{{customerToken}}" }, { "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Cart Items", "description": "Products added to a cart are referred to as a `cart_item`.", "item": [ { "id": "413c9357-b97d-4928-989d-4a18e1da4efa", "name": "Get Cart Items", "request": { "name": "Get Cart Items", "description": { "content": "\nUse this endpoint to retrieve cart items. If the cart is associated with shipping groups, calling this endpoint displays the associated shipping group IDs.\n\nYou can use this endpoint to retrieve the breakdown of cart items by promotion ID. For example, if you have Promotions Standard item discount with code *sale2024*, Rule Promotions item discount with code *sale2024*, and Rule Promotions cart discount with code *sale2024*, the `discounts.constituents` field in the response example will show the breakdown of the same promotion code used in both Promotions Standard and Rule Promotions.\n\n```json\n\"data\": [\n{\n \"id\": \"98de010d-dd10-4fa5-a070-0b9bcdc72974\",\n \"type\": \"cart_item\",\n \"product_id\": \"5a4662d2-9a2b-4f6e-a215-2970db914b0c\",\n \"name\": \"sku1\",\n \"description\": \"sku1\",\n \"sku\": \"sku1\",\n \"slug\": \"sku1\",\n \"image\": {\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"href\": \"\"\n },\n \"quantity\": 1,\n \"manage_stock\": false,\n \"unit_price\": {\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"includes_tax\": false\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": -2000,\n \"currency\": \"USD\",\n \"includes_tax\": false\n },\n \"code\": \"sale2024\",\n \"id\": \"e4d929d5-f471-4317-9a86-a84a6c572b44\",\n \"promotion_source\": \"rule-promotion\",\n \"is_cart_discount\": true\n },\n {\n \"amount\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"includes_tax\": false\n },\n \"code\": \"sale2024\",\n \"id\": \"de19a043-a6da-4bde-b896-d17e16b77e25\",\n \"promotion_source\": \"rule-promotion\"\n },\n {\n \"amount\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"includes_tax\": false\n },\n \"code\": \"sale2024\",\n \"id\": \"509295ee-2971-45b6-801e-95df09756989\"\n },\n {\n \"amount\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"includes_tax\": false\n },\n \"code\": \"sale2024\",\n \"id\": \"ca79e606-7ecd-41ac-9478-af4c8c28c546\",\n \"promotion_source\": \"rule-promotion\",\n \"is_cart_discount\": true\n }\n ],\n \"links\": {\n \"product\": \"https://useast.api.elasticpath.com/v2/products/5a4662d2-9a2b-4f6e-a215-2970db914b0c\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 5000,\n \"currency\": \"USD\",\n \"formatted\": \"$50.00\"\n },\n \"value\": {\n \"amount\": 5000,\n \"currency\": \"USD\",\n \"formatted\": \"$50.00\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 5000,\n \"currency\": \"USD\",\n \"formatted\": \"$50.00\"\n },\n \"value\": {\n \"amount\": 5000,\n \"currency\": \"USD\",\n \"formatted\": \"$50.00\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n },\n \"value\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": -5000,\n \"currency\": \"USD\",\n \"formatted\": \"-$50.00\"\n },\n \"value\": {\n \"amount\": -5000,\n \"currency\": \"USD\",\n \"formatted\": \"-$50.00\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"formatted\": \"$100.00\"\n },\n \"value\": {\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"formatted\": \"$100.00\"\n }\n },\n \"discounts\": {\n \"sale2024\": {\n \"amount\": -5000,\n \"currency\": \"USD\",\n \"formatted\": \"-$50.00\",\n \"constituents\": {\n \"509295ee-2971-45b6-801e-95df09756989\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"formatted\": \"-$10.00\"\n },\n \"ca79e606-7ecd-41ac-9478-af4c8c28c546\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"formatted\": \"-$10.00\"\n },\n \"de19a043-a6da-4bde-b896-d17e16b77e25\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"formatted\": \"-$10.00\"\n },\n \"e4d929d5-f471-4317-9a86-a84a6c572b44\": {\n \"amount\": -2000,\n \"currency\": \"USD\",\n \"formatted\": \"-$20.00\"\n }\n }\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"2024-05-24T18:00:58Z\",\n \"updated_at\": \"2024-05-24T18:00:58Z\"\n }\n },\n \"catalog_id\": \"09b9359f-897f-407f-89a2-702e167fe781\",\n \"catalog_source\": \"pim\"\n}\n```\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma-separated list of related resources to include in the response.", "type": "text/plain" }, "key": "include", "value": "tax_items,custom_discounts" } ], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ee25e3ba-9bfa-43fb-a668-3e80e3c51f67", "name": "200", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma-separated list of related resources to include in the response.", "type": "text/plain" }, "key": "include", "value": "tax_items,custom_discounts" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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\": \"078ed2f1-5022-4907-a408-514c7385b986\",\n \"type\": \"subscription_item\",\n \"product_id\": \"1e23b037-3721-7762-c77d-0d95d5a75a7d\",\n \"promotion_id\": \"b41218eb-59a4-9a1b-5871-6d2796bedf45\",\n \"subscription_offering_id\": \"dd44ed17-7154-5452-23f0-89bc5a7c6d0b\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"sku\": \"string\",\n \"slug\": \"string\",\n \"catalog_id\": \"c0172d50-51b6-d7de-aafb-f5f1261b76d3\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 3980.4715976331217,\n \"key_1\": 7090.40319613179\n },\n \"key_1\": {\n \"key_0\": 3273.7054528012764,\n \"key_1\": 9874.471738983393,\n \"key_2\": 9937.150435938296,\n \"key_3\": 3255.581529895155\n },\n \"key_2\": {\n \"key_0\": 7623.412623282961,\n \"key_1\": 9296.529898564426\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 9333\n },\n \"meta\": {\n \"key_0\": 2557,\n \"key_1\": 644,\n \"key_2\": false,\n \"key_3\": true\n },\n \"price\": {\n \"key_0\": true,\n \"key_1\": true\n },\n \"relationships\": {\n \"key_0\": \"string\",\n \"key_1\": 1489\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 4775,\n \"key_1\": 3712\n },\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n \"price\": {\n \"key_0\": true,\n \"key_1\": 7555\n },\n \"relationships\": {\n \"key_0\": 3901\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 2600.204109179576,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6274.233585542963,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"image\": {\n \"mime_type\": \"string\",\n \"file_name\": \"string\",\n \"href\": \"string\"\n },\n \"quantity\": 2468,\n \"auto_add_quantity\": 1557,\n \"manage_stock\": false,\n \"unit_price\": {\n \"amount\": 424.9725584636099,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"value\": {\n \"amount\": 6130.579766004249,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 5405,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 4180\n },\n {\n \"amount\": {\n \"amount\": 1338,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 7940\n }\n ],\n \"custom_inputs\": {\n \"key_0\": 1536\n },\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n },\n \"links\": {\n \"product\": \"string\",\n \"subscription_offering\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 7330.311576442712,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 3249.5945954493677,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 5165.954238490626,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 2835.6416846369693,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 8785.696768971518,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9246.443082106225,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 3572.312488838183,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 8514.380796693456,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 1910.8252194475695,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6752.794978681205,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 4522.402578577507,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 3217.2628247880543,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 4197,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 6880.937191587053,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 6691.3123421874125,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_2\": {\n \"amount\": 1797.920066572345,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 64,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 1070.338222296643,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_2\": {\n \"amount\": 2503,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 7708.9945502570245,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 3818.7615150293386,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"taxes\": {\n \"data\": null\n },\n \"custom_discounts\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"rule-promotion\",\n \"location\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"integer\",\n \"value\": 6653.204224694276\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": true\n }\n }\n },\n {\n \"id\": \"ca002dab-2cfe-42d9-cb20-1d5e9391198b\",\n \"type\": \"promotion_item\",\n \"product_id\": \"f5a74e25-6b7e-43e6-7bc1-00017121f2b9\",\n \"promotion_id\": \"cb92d20f-2ce6-5965-890e-f62a97f5906d\",\n \"subscription_offering_id\": \"e7a77288-7d23-8298-b138-167511ed3f06\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"sku\": \"string\",\n \"slug\": \"string\",\n \"catalog_id\": \"1e9df964-540b-acbc-3e87-19f8bd727a45\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 9982.047495830315,\n \"key_1\": 8704.791433736802\n },\n \"key_1\": {\n \"key_0\": 7341.938358960762\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 7776.105163269273,\n \"key_1\": 6011,\n \"key_2\": 6382.086323475615\n },\n \"meta\": {\n \"key_0\": 972.8975874301726,\n \"key_1\": true\n },\n \"price\": {\n \"key_0\": false\n },\n \"relationships\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": true\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 5916,\n \"key_1\": \"string\"\n },\n \"meta\": {\n \"key_0\": \"string\"\n },\n \"price\": {\n \"key_0\": \"string\"\n },\n \"relationships\": {\n \"key_0\": 1571.9291599128526,\n \"key_1\": 3414\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 1629.0419925126453,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6707.431053307635,\n \"type\": \"string\"\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 3778.9012281177793,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 3342.9844942754785,\n \"type\": \"string\"\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 713.3330258875347,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6811.604699499682,\n \"type\": \"string\"\n }\n ]\n },\n \"key_3\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 5716.169041691947,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 804.1635488183108,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"image\": {\n \"mime_type\": \"string\",\n \"file_name\": \"string\",\n \"href\": \"string\"\n },\n \"quantity\": 4803,\n \"auto_add_quantity\": 6733,\n \"manage_stock\": true,\n \"unit_price\": {\n \"amount\": 1865.9405501705662,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 3873.851395169332,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 8036,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 917\n },\n {\n \"amount\": {\n \"amount\": 2747,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 1157\n }\n ],\n \"custom_inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 2393\n },\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n },\n \"links\": {\n \"product\": \"string\",\n \"subscription_offering\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 614.7948874772413,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 257.0504390227879,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 5827.422689856075,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7998.604845948583,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 1315.275625045247,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6079.070213312889,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 2462.0141925262005,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 1587.299622764191,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 2290.81788652725,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 5792.548399738244,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 8347.770908135388,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9602.475789341544,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 4761,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 8929.563462207929,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 1867.8948820758467,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 776,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 451.25290348307925,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 7978.805341828472,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_2\": {\n \"amount\": 3128,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 3776.4701182726744,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 3602.1480261382235,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"taxes\": {\n \"data\": null\n },\n \"custom_discounts\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"rule-promotion\",\n \"location\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"float\",\n \"value\": \"string\"\n },\n \"key_1\": {\n \"type\": \"float\",\n \"value\": true\n }\n }\n }\n ],\n \"included\": {\n \"custom_discounts\": [\n {\n \"type\": \"string\",\n \"id\": \"19e7e426-09ec-b8d5-a8b3-72b814d2bf03\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 9662.68439122609,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"3088b6ce-b002-8b25-6fb9-6c513a13d77d\",\n \"type\": \"cart_item\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"25f8822a-40ce-a8dd-a9a0-2c349df90be1\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 5055.205809267382,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"6a526abb-3059-c8b0-fd2b-778cc2ac5432\",\n \"type\": \"custom_item\"\n }\n }\n }\n }\n ],\n \"promotions\": [\n {\n \"automatic\": true,\n \"description\": \"string\",\n \"end\": \"2026-04-21T17:45:18.927Z\",\n \"id\": \"e23f0bd3-a6cd-28f5-1567-c5f27ef0dd24\",\n \"name\": \"string\",\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1990-12-23T12:56:00.821Z\",\n \"type\": \"string\"\n },\n {\n \"automatic\": false,\n \"description\": \"string\",\n \"end\": \"2008-05-08T00:04:16.923Z\",\n \"id\": \"fd756cea-71ff-6803-3709-55b571d8363d\",\n \"name\": \"string\",\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1977-06-17T19:42:42.966Z\",\n \"type\": \"string\"\n }\n ],\n \"tax_items\": [\n {\n \"type\": \"string\",\n \"id\": \"0ebb2b40-cdf5-c0fb-76d8-e1113aff3ab0\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 1928.1541725686814,\n \"amount\": 4737\n },\n {\n \"type\": \"string\",\n \"id\": \"926f2939-2000-3f12-56c6-c299b2b260a3\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 8173.347654185978,\n \"amount\": 6174\n }\n ]\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9632.074933726168,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 2345.6164216474494,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 9747.443269518571,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 406.79962394889026,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 3672.301263491875,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 1380.8233159755523,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 930.1283379158854,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 7218.650503174349,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 6713.1083480602265,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 3226.487255377708,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"expires_at\": \"string\"\n },\n \"messages\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"source\": {\n \"type\": \"string\",\n \"id\": \"string\",\n \"code\": \"string\"\n }\n },\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"source\": {\n \"type\": \"string\",\n \"id\": \"string\",\n \"code\": \"string\"\n }\n }\n ],\n \"promotion_suggestions\": [\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 4941,\n \"targets\": [\n \"string\",\n \"string\"\n ],\n \"key_0\": 7687.4568012811715,\n \"key_1\": 4604.036881925933\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 8390,\n \"targets\": [\n \"string\",\n \"string\"\n ],\n \"key_0\": 7169.379488994059\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\",\n \"auto_add\": true,\n \"targets\": [\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 1746,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 7763,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n },\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 1538,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 8885,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\",\n \"auto_add\": true,\n \"targets\": [\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 5096,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 1718,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n }\n ]\n },\n \"errors\": [\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"43wP9331uQT@KjbAzn.lyn\",\n \"component_product_id\": \"80c43459-eb13-575b-7251-975af6089837\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"hOhhSpO@hhraJYLXVTNEXtoEMNbzOaS.xj\",\n \"component_product_id\": \"e13735ed-1890-e5a1-84ac-d95dae7cd7cb\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "323c0775-248b-46bf-ac2c-75e416f41390", "name": "Bulk Update Items in Cart", "request": { "name": "Bulk Update Items in Cart", "description": { "content": "The bulk update feature allows shoppers to update an array of items to their cart in one action, rather than updating each item one at a time. Shoppers can update quantity and shipping group details in bulk requests. This minimizes the time for shoppers while updating items to their cart. Shoppers can even update multiple items with the same or different shipping groups to their cart.\n\nWhen you update multiple items that qualify for free gifts in the cart, the corresponding free gifts for all eligible products are also automatically updated in the cart.\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"quantity\": 1427,\n \"id\": \"1574e743-937e-33d1-f4e1-d2c1f11cfd40\",\n \"type\": \"custom_item\",\n \"custom_inputs\": {},\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"float\",\n \"value\": false\n },\n \"key_1\": {\n \"type\": \"integer\",\n \"value\": 9411.308172897616\n },\n \"key_2\": {\n \"type\": \"float\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"66524959-6c7a-c147-b787-1d7aa4111800\"\n },\n {\n \"quantity\": 2192,\n \"id\": \"f9d50a78-4642-86a6-676a-dca0069c041d\",\n \"type\": \"cart_item\",\n \"custom_inputs\": {},\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"integer\",\n \"value\": 8251.532287392818\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"27641f0d-c359-811d-1efb-e8c12ba10ef3\"\n }\n ],\n \"options\": {\n \"update_all_or_nothing\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "321d437d-8b86-42de-a18b-402df6f8d989", "name": "Successfully updated cart items", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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 \"data\": [\n {\n \"quantity\": 1427,\n \"id\": \"1574e743-937e-33d1-f4e1-d2c1f11cfd40\",\n \"type\": \"custom_item\",\n \"custom_inputs\": {},\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"float\",\n \"value\": false\n },\n \"key_1\": {\n \"type\": \"integer\",\n \"value\": 9411.308172897616\n },\n \"key_2\": {\n \"type\": \"float\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"66524959-6c7a-c147-b787-1d7aa4111800\"\n },\n {\n \"quantity\": 2192,\n \"id\": \"f9d50a78-4642-86a6-676a-dca0069c041d\",\n \"type\": \"cart_item\",\n \"custom_inputs\": {},\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"integer\",\n \"value\": 8251.532287392818\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"27641f0d-c359-811d-1efb-e8c12ba10ef3\"\n }\n ],\n \"options\": {\n \"update_all_or_nothing\": true\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\": \"078ed2f1-5022-4907-a408-514c7385b986\",\n \"type\": \"subscription_item\",\n \"product_id\": \"1e23b037-3721-7762-c77d-0d95d5a75a7d\",\n \"promotion_id\": \"b41218eb-59a4-9a1b-5871-6d2796bedf45\",\n \"subscription_offering_id\": \"dd44ed17-7154-5452-23f0-89bc5a7c6d0b\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"sku\": \"string\",\n \"slug\": \"string\",\n \"catalog_id\": \"c0172d50-51b6-d7de-aafb-f5f1261b76d3\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 3980.4715976331217,\n \"key_1\": 7090.40319613179\n },\n \"key_1\": {\n \"key_0\": 3273.7054528012764,\n \"key_1\": 9874.471738983393,\n \"key_2\": 9937.150435938296,\n \"key_3\": 3255.581529895155\n },\n \"key_2\": {\n \"key_0\": 7623.412623282961,\n \"key_1\": 9296.529898564426\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 9333\n },\n \"meta\": {\n \"key_0\": 2557,\n \"key_1\": 644,\n \"key_2\": false,\n \"key_3\": true\n },\n \"price\": {\n \"key_0\": true,\n \"key_1\": true\n },\n \"relationships\": {\n \"key_0\": \"string\",\n \"key_1\": 1489\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 4775,\n \"key_1\": 3712\n },\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n \"price\": {\n \"key_0\": true,\n \"key_1\": 7555\n },\n \"relationships\": {\n \"key_0\": 3901\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 2600.204109179576,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6274.233585542963,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"image\": {\n \"mime_type\": \"string\",\n \"file_name\": \"string\",\n \"href\": \"string\"\n },\n \"quantity\": 2468,\n \"auto_add_quantity\": 1557,\n \"manage_stock\": false,\n \"unit_price\": {\n \"amount\": 424.9725584636099,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"value\": {\n \"amount\": 6130.579766004249,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 5405,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 4180\n },\n {\n \"amount\": {\n \"amount\": 1338,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 7940\n }\n ],\n \"custom_inputs\": {\n \"key_0\": 1536\n },\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n },\n \"links\": {\n \"product\": \"string\",\n \"subscription_offering\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 7330.311576442712,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 3249.5945954493677,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 5165.954238490626,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 2835.6416846369693,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 8785.696768971518,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9246.443082106225,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 3572.312488838183,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 8514.380796693456,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 1910.8252194475695,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6752.794978681205,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 4522.402578577507,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 3217.2628247880543,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 4197,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 6880.937191587053,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 6691.3123421874125,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_2\": {\n \"amount\": 1797.920066572345,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 64,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 1070.338222296643,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_2\": {\n \"amount\": 2503,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 7708.9945502570245,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 3818.7615150293386,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"taxes\": {\n \"data\": null\n },\n \"custom_discounts\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"rule-promotion\",\n \"location\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"integer\",\n \"value\": 6653.204224694276\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": true\n }\n }\n },\n {\n \"id\": \"ca002dab-2cfe-42d9-cb20-1d5e9391198b\",\n \"type\": \"promotion_item\",\n \"product_id\": \"f5a74e25-6b7e-43e6-7bc1-00017121f2b9\",\n \"promotion_id\": \"cb92d20f-2ce6-5965-890e-f62a97f5906d\",\n \"subscription_offering_id\": \"e7a77288-7d23-8298-b138-167511ed3f06\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"sku\": \"string\",\n \"slug\": \"string\",\n \"catalog_id\": \"1e9df964-540b-acbc-3e87-19f8bd727a45\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 9982.047495830315,\n \"key_1\": 8704.791433736802\n },\n \"key_1\": {\n \"key_0\": 7341.938358960762\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 7776.105163269273,\n \"key_1\": 6011,\n \"key_2\": 6382.086323475615\n },\n \"meta\": {\n \"key_0\": 972.8975874301726,\n \"key_1\": true\n },\n \"price\": {\n \"key_0\": false\n },\n \"relationships\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": true\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 5916,\n \"key_1\": \"string\"\n },\n \"meta\": {\n \"key_0\": \"string\"\n },\n \"price\": {\n \"key_0\": \"string\"\n },\n \"relationships\": {\n \"key_0\": 1571.9291599128526,\n \"key_1\": 3414\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 1629.0419925126453,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6707.431053307635,\n \"type\": \"string\"\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 3778.9012281177793,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 3342.9844942754785,\n \"type\": \"string\"\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 713.3330258875347,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6811.604699499682,\n \"type\": \"string\"\n }\n ]\n },\n \"key_3\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 5716.169041691947,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 804.1635488183108,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"image\": {\n \"mime_type\": \"string\",\n \"file_name\": \"string\",\n \"href\": \"string\"\n },\n \"quantity\": 4803,\n \"auto_add_quantity\": 6733,\n \"manage_stock\": true,\n \"unit_price\": {\n \"amount\": 1865.9405501705662,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 3873.851395169332,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 8036,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 917\n },\n {\n \"amount\": {\n \"amount\": 2747,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 1157\n }\n ],\n \"custom_inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 2393\n },\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n },\n \"links\": {\n \"product\": \"string\",\n \"subscription_offering\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 614.7948874772413,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 257.0504390227879,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 5827.422689856075,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7998.604845948583,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 1315.275625045247,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6079.070213312889,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 2462.0141925262005,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 1587.299622764191,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 2290.81788652725,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 5792.548399738244,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 8347.770908135388,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9602.475789341544,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 4761,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 8929.563462207929,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 1867.8948820758467,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 776,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 451.25290348307925,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 7978.805341828472,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_2\": {\n \"amount\": 3128,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 3776.4701182726744,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 3602.1480261382235,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"taxes\": {\n \"data\": null\n },\n \"custom_discounts\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"rule-promotion\",\n \"location\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"float\",\n \"value\": \"string\"\n },\n \"key_1\": {\n \"type\": \"float\",\n \"value\": true\n }\n }\n }\n ],\n \"included\": {\n \"custom_discounts\": [\n {\n \"type\": \"string\",\n \"id\": \"19e7e426-09ec-b8d5-a8b3-72b814d2bf03\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 9662.68439122609,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"3088b6ce-b002-8b25-6fb9-6c513a13d77d\",\n \"type\": \"cart_item\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"25f8822a-40ce-a8dd-a9a0-2c349df90be1\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 5055.205809267382,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"6a526abb-3059-c8b0-fd2b-778cc2ac5432\",\n \"type\": \"custom_item\"\n }\n }\n }\n }\n ],\n \"promotions\": [\n {\n \"automatic\": true,\n \"description\": \"string\",\n \"end\": \"2026-04-21T17:45:18.927Z\",\n \"id\": \"e23f0bd3-a6cd-28f5-1567-c5f27ef0dd24\",\n \"name\": \"string\",\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1990-12-23T12:56:00.821Z\",\n \"type\": \"string\"\n },\n {\n \"automatic\": false,\n \"description\": \"string\",\n \"end\": \"2008-05-08T00:04:16.923Z\",\n \"id\": \"fd756cea-71ff-6803-3709-55b571d8363d\",\n \"name\": \"string\",\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1977-06-17T19:42:42.966Z\",\n \"type\": \"string\"\n }\n ],\n \"tax_items\": [\n {\n \"type\": \"string\",\n \"id\": \"0ebb2b40-cdf5-c0fb-76d8-e1113aff3ab0\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 1928.1541725686814,\n \"amount\": 4737\n },\n {\n \"type\": \"string\",\n \"id\": \"926f2939-2000-3f12-56c6-c299b2b260a3\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 8173.347654185978,\n \"amount\": 6174\n }\n ]\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9632.074933726168,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 2345.6164216474494,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 9747.443269518571,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 406.79962394889026,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 3672.301263491875,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 1380.8233159755523,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 930.1283379158854,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 7218.650503174349,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 6713.1083480602265,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 3226.487255377708,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"expires_at\": \"string\"\n },\n \"messages\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"source\": {\n \"type\": \"string\",\n \"id\": \"string\",\n \"code\": \"string\"\n }\n },\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"source\": {\n \"type\": \"string\",\n \"id\": \"string\",\n \"code\": \"string\"\n }\n }\n ],\n \"promotion_suggestions\": [\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 4941,\n \"targets\": [\n \"string\",\n \"string\"\n ],\n \"key_0\": 7687.4568012811715,\n \"key_1\": 4604.036881925933\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 8390,\n \"targets\": [\n \"string\",\n \"string\"\n ],\n \"key_0\": 7169.379488994059\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\",\n \"auto_add\": true,\n \"targets\": [\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 1746,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 7763,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n },\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 1538,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 8885,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\",\n \"auto_add\": true,\n \"targets\": [\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 5096,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 1718,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n }\n ]\n },\n \"errors\": [\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"43wP9331uQT@KjbAzn.lyn\",\n \"component_product_id\": \"80c43459-eb13-575b-7251-975af6089837\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"hOhhSpO@hhraJYLXVTNEXtoEMNbzOaS.xj\",\n \"component_product_id\": \"e13735ed-1890-e5a1-84ac-d95dae7cd7cb\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "751293be-0c81-4b75-a50c-e08b1c38cd01", "name": "Insufficient Stock", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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 \"data\": [\n {\n \"quantity\": 1427,\n \"id\": \"1574e743-937e-33d1-f4e1-d2c1f11cfd40\",\n \"type\": \"custom_item\",\n \"custom_inputs\": {},\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"float\",\n \"value\": false\n },\n \"key_1\": {\n \"type\": \"integer\",\n \"value\": 9411.308172897616\n },\n \"key_2\": {\n \"type\": \"float\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"66524959-6c7a-c147-b787-1d7aa4111800\"\n },\n {\n \"quantity\": 2192,\n \"id\": \"f9d50a78-4642-86a6-676a-dca0069c041d\",\n \"type\": \"cart_item\",\n \"custom_inputs\": {},\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"integer\",\n \"value\": 8251.532287392818\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"27641f0d-c359-811d-1efb-e8c12ba10ef3\"\n }\n ],\n \"options\": {\n \"update_all_or_nothing\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"There is not enough stock to add Fry Pan to your cart\",\n \"meta\": {\n \"id\": \"0e5bae32-cc71-4ede-8d7d-cb662e90c542\"\n },\n \"status\": 400,\n \"title\": \"Insufficient stock\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b33b6ee-e1b2-4f55-9c07-47d7180753df", "name": "Unauthorized call", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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 \"data\": [\n {\n \"quantity\": 1427,\n \"id\": \"1574e743-937e-33d1-f4e1-d2c1f11cfd40\",\n \"type\": \"custom_item\",\n \"custom_inputs\": {},\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"float\",\n \"value\": false\n },\n \"key_1\": {\n \"type\": \"integer\",\n \"value\": 9411.308172897616\n },\n \"key_2\": {\n \"type\": \"float\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"66524959-6c7a-c147-b787-1d7aa4111800\"\n },\n {\n \"quantity\": 2192,\n \"id\": \"f9d50a78-4642-86a6-676a-dca0069c041d\",\n \"type\": \"cart_item\",\n \"custom_inputs\": {},\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"integer\",\n \"value\": 8251.532287392818\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"27641f0d-c359-811d-1efb-e8c12ba10ef3\"\n }\n ],\n \"options\": {\n \"update_all_or_nothing\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"No permissions to fulfill this request with cart item custom_attributes\",\n \"meta\": {\n \"id\": \"0e5bae32-cc71-4ede-8d7d-cb662e90c542\"\n },\n \"status\": 403,\n \"title\": \"Unauthorised call\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c940dfe5-e7ee-4f15-9ada-14065f15c56a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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 \"data\": [\n {\n \"quantity\": 1427,\n \"id\": \"1574e743-937e-33d1-f4e1-d2c1f11cfd40\",\n \"type\": \"custom_item\",\n \"custom_inputs\": {},\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"float\",\n \"value\": false\n },\n \"key_1\": {\n \"type\": \"integer\",\n \"value\": 9411.308172897616\n },\n \"key_2\": {\n \"type\": \"float\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"66524959-6c7a-c147-b787-1d7aa4111800\"\n },\n {\n \"quantity\": 2192,\n \"id\": \"f9d50a78-4642-86a6-676a-dca0069c041d\",\n \"type\": \"cart_item\",\n \"custom_inputs\": {},\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"integer\",\n \"value\": 8251.532287392818\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"27641f0d-c359-811d-1efb-e8c12ba10ef3\"\n }\n ],\n \"options\": {\n \"update_all_or_nothing\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Item was not found in the cart\",\n \"meta\": {\n \"id\": \"0e5bae32-cc71-4ede-8d7d-cb662e90c542\",\n \"ids\": [\n \"0e5bae32-cc71-4ede-8d7d-cb662e90c542\"\n ]\n },\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d521280-f2b2-4e5a-88b7-2d98d74e1810", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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 \"data\": [\n {\n \"quantity\": 1427,\n \"id\": \"1574e743-937e-33d1-f4e1-d2c1f11cfd40\",\n \"type\": \"custom_item\",\n \"custom_inputs\": {},\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"float\",\n \"value\": false\n },\n \"key_1\": {\n \"type\": \"integer\",\n \"value\": 9411.308172897616\n },\n \"key_2\": {\n \"type\": \"float\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"66524959-6c7a-c147-b787-1d7aa4111800\"\n },\n {\n \"quantity\": 2192,\n \"id\": \"f9d50a78-4642-86a6-676a-dca0069c041d\",\n \"type\": \"cart_item\",\n \"custom_inputs\": {},\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"integer\",\n \"value\": 8251.532287392818\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"27641f0d-c359-811d-1efb-e8c12ba10ef3\"\n }\n ],\n \"options\": {\n \"update_all_or_nothing\": true\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 \"errors\": [\n {\n \"detail\": \"The cart is configured to use custom discounts\",\n \"meta\": {\n \"code\": \"10_OFF\",\n \"ids\": [\n \"0e5bae32-cc71-4ede-8d7d-cb662e90c542\"\n ]\n },\n \"status\": 422,\n \"title\": \"Could not apply EP promotion with the given code\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95829b97-9dca-467b-88b6-83b653ee5ce4", "name": "Add Items to Cart", "request": { "name": "Add Items to Cart", "description": { "content": "\n### Add Product to Cart\n\nAdding a Product to Cart is the most common Cart action. If you want to add any custom products or promotions, you need to do that as a separate action.\n\n#### Dynamic Bundles\n\nA bundle is a purchasable product that is composed of a combination of two or more products that you want to sell together. You can create multiple components within a bundle. Each component can have one or more options. Each option is a product and a quantity. You can configure minimum and/or maximum values for the number of product options in a component that your shoppers can select. For example, you can enable a shopper to select 1 or more product options from a list of 10. These are called [dynamic bundles](/docs/api/pxm/products/products#dynamic-bundles).\n\nYour dynamic bundles are displayed in your published catalogs.\n\n1. Use the configure a shopper endpoint to allow shoppers to make their selections from a bundle.\n2. In the response of the configure a shopper, the `bundle_configuration` object contains the bundle selections a shopper has made.\n3. In the add a product to cart request, use the `bundle_configuration` object to add the customers selections to a cart.\n\n```json\n \"bundle_configuration\": {\n \"selected_options\": {\n \"games\": {\n \"d7b79eb8-19d8-45ea-86ed-2324a604dd9c\": 1\n },\n \"toys\": {\n \"0192ccdd-6d33-4898-87d7-c4d87f2bf8ea\": 1,\n \"1aea6f97-f0d9-452c-b3c1-7fb5629ead82\": 1\n }\n }\n}\n```\n\nWhen a cart is checked out, the options a shopper selected are added to the order. See [order items](/docs/api/carts/get-order-items).\n\n#### Personalized Products\n\nYou can allow shoppers to personalize their goods by adding custom text inputs to products directly. This feature is particularly useful for customizable items, such as personalized T-shirts or greeting cards. You can use this functionality by leveraging the `custom_inputs` attribute, and defining the details and validation rules for the custom text.\n\nFirst, you must configure a `custom_inputs` attribute when creating a new product or updating an existing product. Once you have defined your custom inputs on a product, you must configure the custom inputs in your orders.\n\nFor example, you may sell T-shirts that can have personalized text on the front and back of the shirt.\n\n```json\n {\n \"data\": {\n \"type\": \"product\",\n \"attributes\": {\n \"custom_inputs\": {\n \"front\": {\n \"name\": \"T-Shirt Front\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n },\n \"back\": {\n \"name\": \"T-Shirt Back\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n }\n }\n }\n }\n}\n```\n\nIf the same product has different `custom_inputs` attributes, then these are added as separate items in a cart.\n\nThe `custom_inputs` attribute is stored in the cart item and the text for `custom_input` must not exceed 255 characters in length. When a cart is checked out, the `custom_inputs` attribute becomes part of the order.\n\n#### Limitations on Usage of `custom_inputs` with Specific Promotion Types\n\nWhen you add products to a cart with `custom_inputs`, there are certain limitations on usage of the `custom_inputs` with the following promotion types:\n\n - For [Free Gift Promotions](/docs/api/promotions/create-a-promotion), you can add `custom_inputs` to gift items.\n - For [Fixed Bundle Discount Promotions](/docs/api/promotions/create-a-promotion), the promotion applies as long as the cart contains the bundle SKUs even when there are different `custom_inputs`.\n - For [X for Y Discount Promotion and X for amount discount promotion](/docs/api/promotions/create-a-promotion), the promotion applies when there are two SKUs with the same `custom_inputs`. The promotion does not apply when there are different `custom_inputs` and the SKUs are in different line items.\n\n#### Stock locations\n\nWhen adding to a cart it is possible to specify which [stock location](/docs/api/pxm/inventory_mli/inventories-introduction?#multi-location-inventories) should be used for tracking inventory for that product by specifying its slug in `location`. This might represent the warehouse a product is shipped from or the store holding the stock in a Buy Online Pick Up In Store scenario.\n\nEach line item is restricted to a single stock location. If the same product is added with a different location then the most recently-specified location will be used for the total quantity of that line item.\n\n:::note\n\n- Any requests to add a product to cart returns the collection of cart items.\n- [Tax items](/docs/api/carts/tax-items) may optionally be added with the product. Only administrators with [client_credentials access tokens](/docs/api/authentication/create-an-access-token) are able to do this. If included, they replace any existing taxes on the product.\n- The cart currency is set when the first item is added to the cart.\n- The product being added to the cart requires a price in the same currency as the other items in the cart. The API returns a 400 error if a price is not defined in the correct currency.\n- A cart can contain a maximum of 100 unique items. Items include products, custom items, tax items, and promotions.\n- There are a number of actions that happen to your inventory when checking out and paying for an order. For more information, see the [Inventory](/docs/api/pxm/inventory/inventories-introduction) documentation.\n\n:::\n\n### Including Resources\n\nWhen you make an `Add Product to Cart` request to the catalog-view service, you can obtain details of the component products. If you include the optional parameter `include=component_products` in the request, the response will include details for each component product.\n\nWhen a bundle with selected component products is added to a cart, the cart displays both the bundle pricing and component product IDs.\n\nThe response example is returned with a new field called `component_products` under `bundle_configuration`, which is a list of component products that the user has selected for dynamic bundles.\n\n| Parameter | Required | Description |\n|:------------------------|:-------------|:-------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n| `files` | Optional | Any files associated with a product. |\n\n```json\n\"bundle_configuration\": {\n \"selected_options\": {\n \"mixed-shirts\": {\n \"16a6cc14-6ebb-4156-9973-e6a0f92f5731\": 3,\n \"55037cc5-f382-4039-95c6-1e04ac0351d3\": 2,\n \"standard-shirts\"\n \"70f1c9d2-c580-4839-bd6c-a0a9b91d5159\": 5\n }\n },\n \"component_products\": [\n {\n \"id\": \"16a6cc14-6ebb-4156-9973-e6a0f92f5731\",\n \"type\": \"product\",\n \"attributes\": {\n \"name\": \"Red T-shirt\",\n \"description\": \"Standard red t-shirt.\",\n \"slug\": \"red-t-shirt-slug\",\n \"sku\": \"red-t-shirt-sku\",\n \"status\": \"live\",\n \"commodity_type\": \"physical\"\n },\n \"meta\": {\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 500,\n \"currency\": \"USD\",\n \"formatted\": \"$5.00\"\n }\n }\n }\n },\n {\n \"id\": \"55037cc5-f382-4039-95c6-1e04ac0351d3\",\n \"type\": \"product\",\n \"attributes\": {\n \"name\": \"Blue T-shirt\",\n \"description\": \"Standard blue t-shirt.\",\n \"slug\": \"blue-t-shirt-slug\",\n \"sku\": \"blue-t-shirt-sku\",\n \"status\": \"live\",\n \"commodity_type\": \"physical\"\n },\n \"meta\": {\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 500,\n \"currency\": \"USD\",\n \"formatted\": \"$5.00\"\n }\n }\n }\n },\n {\n \"id\": \"70f1c9d2-c580-4839-bd6c-a0a9b91d5159\",\n \"type\": \"product\",\n \"attributes\": {\n \"name\": \"White T-shirt\",\n \"description\": \"Standard white t-shirt.\",\n \"slug\": \"white-t-shirt-slug\",\n \"sku\": \"white-t-shirt-sku\",\n \"status\": \"live\",\n \"commodity_type\": \"physical\"\n },\n \"meta\": {\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 500,\n \"currency\": \"USD\",\n \"formatted\": \"$5.00\"\n }\n }\n }\n }\n ]\n}\n```\n\nSee [Including Resources](https://elasticpath.dev/guides/Getting-Started/includes).\n\n### Add Subscription to Cart\n\nTo add a subscription to your cart, you need to provide the ID of the subscription offering, and the ID of the pricing option and plan within that offering that you want to subscribe to.\n\n```json\n {\n {\n \"data\": {\n \"id\": \"5b9be99f-1c94-4ddd-9718-81adab0cc3e0\",\n \"type\": \"subscription_item\",\n \"quantity\": 1,\n \"subscription_configuration\": {\n \"plan\": \"dfa31307-748c-4369-8571-709f924a0807\",\n \"pricing_option\": \"40010dde-2f38-489b-8b3f-14a13cbfb431\"\n }\n }\n }\n```\n\nThe price of the subscription item in the cart reflects the cost of the subscription's initial billing period. Once the cart has been checked out and the order paid for, the subscription will be automatically created in the subscriptions service.\n\n### Add Custom Item to Cart\n\nYou can add a custom item to the cart when you don't manage things like shipping, taxes and inventory in Commerce.\n\nFor [Shipping Groups](/docs/ship-groups/shipping-groups/index), once you have created a [cart shipping group](/docs/ship-groups/shipping-groups/shipping-groups-api/create-cart-shipping-group), you need to link it to the cart items. This is important, because it is necessary to associate items with shipping groups in order to include shipping groups in the corresponding cart, order, and totals.\n\n:::note\n\n- Custom Cart Items are available when using [implicit access tokens](/docs/api/authentication/create-an-access-token). Ensure that you always check each order has the correct details for each item, most importantly, price.\n\n:::\n\n### Add Promotion to Cart\n\nYou can use the Promotions API to apply discounts to your cart as a special cart item type. Any requests to add a product to cart will return a collection of cart items.\n\n There are certain limitations on usage of the `custom_inputs` attribute with some promotion types. See [Limitations on Usage of `custom_inputs` with Specific Promotion Types](/docs/api/carts/manage-carts#limitations-on-usage-of-custom_inputs-with-specific-promotion-types).\n\nTo remove promotion from the cart via the promotion code, see [Delete Promotion Code from Cart](/docs/api/carts/delete-a-promotion-via-promotion-code).\n\n### Re-order\n\nFrom a shopper's order history, they can add the items from a previous order into their carts. Shoppers can add items regardless of past order status, such as incomplete or not paid. For more information, see [Orders](/docs/api/carts/orders).\n\n:::note\n - Any requests to add an item to cart return a collection of [cart items](/docs/api/carts/cart-items).\n - A cart can contain a maximum of 100 unique items. Items include products, custom items, and promotions.\n - When a shopper creates a cart and re-orders items from an order with properties such as custom attributes, custom discounts, and payment intent ID, these properties will remain unchanged in the original cart.\n - Custom items do not exist in catalogs, and therefore cannot be reordered.\n:::\n\n### Merging Carts\n\nA shopper can have multiple carts, and the system may automatically merge items from an anonymous cart into the shopper's registered cart when they sign in. For example, if a shopper has an existing cart with items `A`, `B` and `C`, and later adds items `D` and `E` while not signed in, the system can merge these carts when the shopper signs in. After the carts merge, the cart contains items `A`, `B`, `C`, `D` and `E`.\n\nIf any items are duplicated from the anonymous cart to the registered cart, their quantities are incremented accordingly. For example, if a shopper's existing cart with items `A`, `B` and `C`, and they later add two more `A` items and one `B` item while not signed in, the system will merge the carts when the shopper signs in. The existing cart will now contain three `A` items, two `B` items, and one `C` item.\n\n:::note\n\nWhen the system merges items from one cart into another cart, properties such as custom attributes, custom discounts, and payment intent ID will remain unchanged in the original cart.\n\n:::\n\n### Best Practices\n\nWe recommend to include a unique `sku` code within the request body while adding custom items to carts. If the same `sku` is used for multiple products, they are merged into a single line item.\n\nFor example, if a cart consists of the following items:\n\n- `product-1` with quantity 1 and sku code as `sku-1`\n- `product-2` with quantity 1 and sku code as `sku-1`\n- `product-3` with quantity 1 and sku code as `sku-2`.\n\nThe following response is returned where it combines all products with the same sku codes into a single line item, while products with a unique sku codes are represented as separate items:\n\n```json\n{\n \"data\": [\n {\n \"id\": \"c58760f4-8889-4719-b34d-be1f1d11ae59\",\n \"type\": \"custom_item\",\n \"name\": \"product-1\",\n \"description\": \"My first custom item!\",\n \"sku\": \"sku-1\",\n \"slug\": \"\",\n \"image\": {\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"href\": \"\"\n },\n \"quantity\": 2,\n \"manage_stock\": false,\n \"unit_price\": {\n \"amount\": 20000,\n \"currency\": \"USD\",\n \"includes_tax\": true\n },\n \"value\": {\n \"amount\": 40000,\n \"currency\": \"USD\",\n \"includes_tax\": true\n },\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 20000,\n \"currency\": \"USD\",\n \"formatted\": \"$200.00\"\n },\n \"value\": {\n \"amount\": 40000,\n \"currency\": \"USD\",\n \"formatted\": \"$400.00\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 20000,\n \"currency\": \"USD\",\n \"formatted\": \"$200.00\"\n },\n \"value\": {\n \"amount\": 40000,\n \"currency\": \"USD\",\n \"formatted\": \"$400.00\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n },\n \"value\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n },\n \"value\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 20000,\n \"currency\": \"USD\",\n \"formatted\": \"$200.00\"\n },\n \"value\": {\n \"amount\": 40000,\n \"currency\": \"USD\",\n \"formatted\": \"$400.00\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"2023-05-02T16:28:11Z\",\n \"updated_at\": \"2023-05-02T16:28:18Z\"\n }\n }\n ]\n ```\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"df32387b-6ce6-4802-9b90-1126a5c5a54f\",\n \"quantity\": 1,\n \"custom_inputs\": {\n \"name\": {\n \"tshirt_front\": \"Jane\",\n \"tshirt_back\": \"Jane Doe's Dance Academy\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7e78427f-f276-421a-a104-624c27934f0f", "name": "Successfully added item(s) to cart. When promotions are added, the response includes informational messages in the `meta.messages` field describing the promotion and discount effects.", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"df32387b-6ce6-4802-9b90-1126a5c5a54f\",\n \"quantity\": 1,\n \"custom_inputs\": {\n \"name\": {\n \"tshirt_front\": \"Jane\",\n \"tshirt_back\": \"Jane Doe's Dance Academy\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"1359223e-5de0-4d42-a2ec-14350a84c173\",\n \"type\": \"custom_item\",\n \"name\": \"My Custom Item\",\n \"description\": \"My first custom item!\",\n \"sku\": \"Sample-sku\",\n \"slug\": \"\",\n \"image\": {\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"href\": \"\"\n },\n \"quantity\": 1,\n \"manage_stock\": false,\n \"unit_price\": {\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"includes_tax\": true\n },\n \"value\": {\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"includes_tax\": false\n },\n \"code\": \"auto_4c8cc302-b1e8-4d1e-a1d5-fb74fda83705\",\n \"id\": \"4c8cc302-b1e8-4d1e-a1d5-fb74fda83705\",\n \"promotion_source\": \"rule-promotion\",\n \"is_cart_discount\": true,\n \"ordinal\": 1\n }\n ],\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 9000,\n \"currency\": \"USD\",\n \"formatted\": \"$90.00\"\n },\n \"value\": {\n \"amount\": 9000,\n \"currency\": \"USD\",\n \"formatted\": \"$90.00\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 9000,\n \"currency\": \"USD\",\n \"formatted\": \"$90.00\"\n },\n \"value\": {\n \"amount\": 9000,\n \"currency\": \"USD\",\n \"formatted\": \"$90.00\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n },\n \"value\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"formatted\": \"-$10.00\"\n },\n \"value\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"formatted\": \"-$10.00\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"formatted\": \"$100.00\"\n },\n \"value\": {\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"formatted\": \"$100.00\"\n }\n },\n \"discounts\": {\n \"auto_4c8cc302-b1e8-4d1e-a1d5-fb74fda83705\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"formatted\": \"-$10.00\",\n \"constituents\": {\n \"4c8cc302-b1e8-4d1e-a1d5-fb74fda83705\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"formatted\": \"-$10.00\"\n }\n }\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"2025-09-10T22:28:29Z\",\n \"updated_at\": \"2025-09-10T22:28:29Z\"\n }\n }\n },\n {\n \"id\": \"7a7fb70a-561a-4caf-a112-c3e5a74145f4\",\n \"type\": \"promotion_item\",\n \"promotion_id\": \"4c8cc302-b1e8-4d1e-a1d5-fb74fda83705\",\n \"name\": \"cart auto\",\n \"description\": \"Promotion\",\n \"sku\": \"auto_4c8cc302-b1e8-4d1e-a1d5-fb74fda83705\",\n \"slug\": \"\",\n \"image\": {\n \"mime_type\": \"\",\n \"file_name\": \"\",\n \"href\": \"\"\n },\n \"quantity\": 1,\n \"manage_stock\": false,\n \"unit_price\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"includes_tax\": false\n },\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"formatted\": \"-$10.00\"\n },\n \"value\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"formatted\": \"-$10.00\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"formatted\": \"-$10.00\"\n },\n \"value\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"formatted\": \"-$10.00\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n },\n \"value\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n },\n \"value\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 0,\n \"currency\": \"\",\n \"formatted\": \"0\"\n },\n \"value\": {\n \"amount\": 0,\n \"currency\": \"\",\n \"formatted\": \"0\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"2025-09-10T22:28:29Z\",\n \"updated_at\": \"2025-09-10T22:28:29Z\"\n }\n },\n \"promotion_source\": \"rule-promotion\"\n }\n ],\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9000,\n \"currency\": \"USD\",\n \"formatted\": \"$90.00\"\n },\n \"without_tax\": {\n \"amount\": 9000,\n \"currency\": \"USD\",\n \"formatted\": \"$90.00\"\n },\n \"tax\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n },\n \"discount\": {\n \"amount\": -1000,\n \"currency\": \"USD\",\n \"formatted\": \"-$10.00\"\n },\n \"without_discount\": {\n \"amount\": 10000,\n \"currency\": \"USD\",\n \"formatted\": \"$100.00\"\n },\n \"shipping\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n },\n \"shipping_discount\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"2025-09-08T13:17:42Z\",\n \"updated_at\": \"2025-09-10T22:28:29Z\",\n \"expires_at\": \"2025-09-17T22:28:29Z\"\n },\n \"messages\": [\n {\n \"source\": {\n \"type\": \"promotion_item\",\n \"id\": \"7a7fb70a-561a-4caf-a112-c3e5a74145f4\"\n },\n \"title\": \"Promotion Added\",\n \"description\": \"Promotion has been added to cart.\"\n },\n {\n \"source\": {\n \"type\": \"custom_item\",\n \"id\": \"1359223e-5de0-4d42-a2ec-14350a84c173\"\n },\n \"title\": \"Discount Added\",\n \"description\": \"Item discount has been added.\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01aff372-b5a6-459b-b03b-f6d97724d8a6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"df32387b-6ce6-4802-9b90-1126a5c5a54f\",\n \"quantity\": 1,\n \"custom_inputs\": {\n \"name\": {\n \"tshirt_front\": \"Jane\",\n \"tshirt_back\": \"Jane Doe's Dance Academy\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Must be greater than or equal to 0\",\n \"meta\": {\n \"value\": -100000\n },\n \"status\": 400,\n \"title\": \"number_gte\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3fba10a-a8d5-421b-84ac-1bc3a2b7fa0c", "name": "Unauthorized call", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"df32387b-6ce6-4802-9b90-1126a5c5a54f\",\n \"quantity\": 1,\n \"custom_inputs\": {\n \"name\": {\n \"tshirt_front\": \"Jane\",\n \"tshirt_back\": \"Jane Doe's Dance Academy\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"No permissions to fulfill this request with cart item custom_attributes\",\n \"status\": 403,\n \"title\": \"Unauthorised call\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b90f8f7-e252-4387-86c0-e38dcfb37e32", "name": "Not Found - occurs when a referenced product or promotion cannot be found. For bulk operations with add_all_or_nothing=true, the entire operation fails if any item is invalid.", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"df32387b-6ce6-4802-9b90-1126a5c5a54f\",\n \"quantity\": 1,\n \"custom_inputs\": {\n \"name\": {\n \"tshirt_front\": \"Jane\",\n \"tshirt_back\": \"Jane Doe's Dance Academy\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The requested product could not be found\",\n \"meta\": {\n \"id\": \"1c73326e-07e0-4043-81fc-54b8f13daeb4\"\n },\n \"status\": 404,\n \"title\": \"Product not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dcbea63-c78a-4173-bf83-aa2809ec5cdc", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"df32387b-6ce6-4802-9b90-1126a5c5a54f\",\n \"quantity\": 1,\n \"custom_inputs\": {\n \"name\": {\n \"tshirt_front\": \"Jane\",\n \"tshirt_back\": \"Jane Doe's Dance Academy\"\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 \"errors\": [\n {\n \"detail\": \"The cart is configured to use custom discounts\",\n \"meta\": {\n \"code\": \"10_OFF\",\n \"ids\": [\n \"0e5bae32-cc71-4ede-8d7d-cb662e90c542\"\n ]\n },\n \"status\": 422,\n \"title\": \"Could not apply EP promotion with the given code\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffda837b-a996-4b26-9d6e-e2eb3e8a6d6d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"df32387b-6ce6-4802-9b90-1126a5c5a54f\",\n \"quantity\": 1,\n \"custom_inputs\": {\n \"name\": {\n \"tshirt_front\": \"Jane\",\n \"tshirt_back\": \"Jane Doe's Dance Academy\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86053651-afe7-4f0a-aa68-c5baed4f781e", "name": "Delete all Cart Items", "request": { "name": "Delete all Cart Items", "description": { "content": "A shopper can clean up their cart, deleting custom items, promotions, and so on, while the empty cart remains available. The cart id, name, description, and any account or customer associations persist. The shopper can continue to add items to the cart.\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart created by you.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "22a7afa3-16a8-496e-b419-7e6747c5ff63", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart created by you.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "a80ae001-4594-42f4-9669-4a964b7b70a6", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart created by you.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The cart is configured to use custom discounts\",\n \"meta\": {\n \"code\": \"10_OFF\"\n },\n \"status\": 422,\n \"title\": \"Could not apply EP promotion with the given code\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dfe73614-a929-4028-9e2c-74dcd8ea84b2", "name": "Update a Cart Item", "request": { "name": "Update a Cart Item", "description": { "content": "You can easily update a cart item. A successful update returns the cart items.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) A unique identifier of the cart that you created.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "cartitemID", "disabled": false, "description": { "content": "(Required) A unique identifier of the cart item.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"76746981-f63a-45f4-ba9e-59773d89dc2e\",\n \"custom_inputs\": {\n \"personalization\": \"My personal message\"\n },\n \"quantity\": 2\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "51e9c40e-0513-4459-a98f-dceebb6ff71a", "name": "200", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" } ] }, "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 \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"76746981-f63a-45f4-ba9e-59773d89dc2e\",\n \"custom_inputs\": {\n \"personalization\": \"My personal message\"\n },\n \"quantity\": 2\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\": \"078ed2f1-5022-4907-a408-514c7385b986\",\n \"type\": \"subscription_item\",\n \"product_id\": \"1e23b037-3721-7762-c77d-0d95d5a75a7d\",\n \"promotion_id\": \"b41218eb-59a4-9a1b-5871-6d2796bedf45\",\n \"subscription_offering_id\": \"dd44ed17-7154-5452-23f0-89bc5a7c6d0b\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"sku\": \"string\",\n \"slug\": \"string\",\n \"catalog_id\": \"c0172d50-51b6-d7de-aafb-f5f1261b76d3\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 3980.4715976331217,\n \"key_1\": 7090.40319613179\n },\n \"key_1\": {\n \"key_0\": 3273.7054528012764,\n \"key_1\": 9874.471738983393,\n \"key_2\": 9937.150435938296,\n \"key_3\": 3255.581529895155\n },\n \"key_2\": {\n \"key_0\": 7623.412623282961,\n \"key_1\": 9296.529898564426\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 9333\n },\n \"meta\": {\n \"key_0\": 2557,\n \"key_1\": 644,\n \"key_2\": false,\n \"key_3\": true\n },\n \"price\": {\n \"key_0\": true,\n \"key_1\": true\n },\n \"relationships\": {\n \"key_0\": \"string\",\n \"key_1\": 1489\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 4775,\n \"key_1\": 3712\n },\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n \"price\": {\n \"key_0\": true,\n \"key_1\": 7555\n },\n \"relationships\": {\n \"key_0\": 3901\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 2600.204109179576,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6274.233585542963,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"image\": {\n \"mime_type\": \"string\",\n \"file_name\": \"string\",\n \"href\": \"string\"\n },\n \"quantity\": 2468,\n \"auto_add_quantity\": 1557,\n \"manage_stock\": false,\n \"unit_price\": {\n \"amount\": 424.9725584636099,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"value\": {\n \"amount\": 6130.579766004249,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 5405,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 4180\n },\n {\n \"amount\": {\n \"amount\": 1338,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 7940\n }\n ],\n \"custom_inputs\": {\n \"key_0\": 1536\n },\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n },\n \"links\": {\n \"product\": \"string\",\n \"subscription_offering\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 7330.311576442712,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 3249.5945954493677,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 5165.954238490626,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 2835.6416846369693,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 8785.696768971518,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9246.443082106225,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 3572.312488838183,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 8514.380796693456,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 1910.8252194475695,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6752.794978681205,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 4522.402578577507,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 3217.2628247880543,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 4197,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 6880.937191587053,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 6691.3123421874125,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_2\": {\n \"amount\": 1797.920066572345,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 64,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 1070.338222296643,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_2\": {\n \"amount\": 2503,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 7708.9945502570245,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 3818.7615150293386,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"taxes\": {\n \"data\": null\n },\n \"custom_discounts\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"rule-promotion\",\n \"location\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"integer\",\n \"value\": 6653.204224694276\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": true\n }\n }\n },\n {\n \"id\": \"ca002dab-2cfe-42d9-cb20-1d5e9391198b\",\n \"type\": \"promotion_item\",\n \"product_id\": \"f5a74e25-6b7e-43e6-7bc1-00017121f2b9\",\n \"promotion_id\": \"cb92d20f-2ce6-5965-890e-f62a97f5906d\",\n \"subscription_offering_id\": \"e7a77288-7d23-8298-b138-167511ed3f06\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"sku\": \"string\",\n \"slug\": \"string\",\n \"catalog_id\": \"1e9df964-540b-acbc-3e87-19f8bd727a45\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 9982.047495830315,\n \"key_1\": 8704.791433736802\n },\n \"key_1\": {\n \"key_0\": 7341.938358960762\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 7776.105163269273,\n \"key_1\": 6011,\n \"key_2\": 6382.086323475615\n },\n \"meta\": {\n \"key_0\": 972.8975874301726,\n \"key_1\": true\n },\n \"price\": {\n \"key_0\": false\n },\n \"relationships\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": true\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 5916,\n \"key_1\": \"string\"\n },\n \"meta\": {\n \"key_0\": \"string\"\n },\n \"price\": {\n \"key_0\": \"string\"\n },\n \"relationships\": {\n \"key_0\": 1571.9291599128526,\n \"key_1\": 3414\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 1629.0419925126453,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6707.431053307635,\n \"type\": \"string\"\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 3778.9012281177793,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 3342.9844942754785,\n \"type\": \"string\"\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 713.3330258875347,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6811.604699499682,\n \"type\": \"string\"\n }\n ]\n },\n \"key_3\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 5716.169041691947,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 804.1635488183108,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"image\": {\n \"mime_type\": \"string\",\n \"file_name\": \"string\",\n \"href\": \"string\"\n },\n \"quantity\": 4803,\n \"auto_add_quantity\": 6733,\n \"manage_stock\": true,\n \"unit_price\": {\n \"amount\": 1865.9405501705662,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 3873.851395169332,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 8036,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 917\n },\n {\n \"amount\": {\n \"amount\": 2747,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 1157\n }\n ],\n \"custom_inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 2393\n },\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n },\n \"links\": {\n \"product\": \"string\",\n \"subscription_offering\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 614.7948874772413,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 257.0504390227879,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 5827.422689856075,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7998.604845948583,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 1315.275625045247,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6079.070213312889,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 2462.0141925262005,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 1587.299622764191,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 2290.81788652725,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 5792.548399738244,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 8347.770908135388,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9602.475789341544,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 4761,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 8929.563462207929,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 1867.8948820758467,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 776,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 451.25290348307925,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 7978.805341828472,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_2\": {\n \"amount\": 3128,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 3776.4701182726744,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 3602.1480261382235,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"taxes\": {\n \"data\": null\n },\n \"custom_discounts\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"rule-promotion\",\n \"location\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"float\",\n \"value\": \"string\"\n },\n \"key_1\": {\n \"type\": \"float\",\n \"value\": true\n }\n }\n }\n ],\n \"included\": {\n \"custom_discounts\": [\n {\n \"type\": \"string\",\n \"id\": \"19e7e426-09ec-b8d5-a8b3-72b814d2bf03\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 9662.68439122609,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"3088b6ce-b002-8b25-6fb9-6c513a13d77d\",\n \"type\": \"cart_item\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"25f8822a-40ce-a8dd-a9a0-2c349df90be1\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 5055.205809267382,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"6a526abb-3059-c8b0-fd2b-778cc2ac5432\",\n \"type\": \"custom_item\"\n }\n }\n }\n }\n ],\n \"promotions\": [\n {\n \"automatic\": true,\n \"description\": \"string\",\n \"end\": \"2026-04-21T17:45:18.927Z\",\n \"id\": \"e23f0bd3-a6cd-28f5-1567-c5f27ef0dd24\",\n \"name\": \"string\",\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1990-12-23T12:56:00.821Z\",\n \"type\": \"string\"\n },\n {\n \"automatic\": false,\n \"description\": \"string\",\n \"end\": \"2008-05-08T00:04:16.923Z\",\n \"id\": \"fd756cea-71ff-6803-3709-55b571d8363d\",\n \"name\": \"string\",\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1977-06-17T19:42:42.966Z\",\n \"type\": \"string\"\n }\n ],\n \"tax_items\": [\n {\n \"type\": \"string\",\n \"id\": \"0ebb2b40-cdf5-c0fb-76d8-e1113aff3ab0\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 1928.1541725686814,\n \"amount\": 4737\n },\n {\n \"type\": \"string\",\n \"id\": \"926f2939-2000-3f12-56c6-c299b2b260a3\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 8173.347654185978,\n \"amount\": 6174\n }\n ]\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9632.074933726168,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 2345.6164216474494,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 9747.443269518571,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 406.79962394889026,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 3672.301263491875,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 1380.8233159755523,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 930.1283379158854,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 7218.650503174349,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 6713.1083480602265,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 3226.487255377708,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"expires_at\": \"string\"\n },\n \"messages\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"source\": {\n \"type\": \"string\",\n \"id\": \"string\",\n \"code\": \"string\"\n }\n },\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"source\": {\n \"type\": \"string\",\n \"id\": \"string\",\n \"code\": \"string\"\n }\n }\n ],\n \"promotion_suggestions\": [\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 4941,\n \"targets\": [\n \"string\",\n \"string\"\n ],\n \"key_0\": 7687.4568012811715,\n \"key_1\": 4604.036881925933\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 8390,\n \"targets\": [\n \"string\",\n \"string\"\n ],\n \"key_0\": 7169.379488994059\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\",\n \"auto_add\": true,\n \"targets\": [\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 1746,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 7763,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n },\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 1538,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 8885,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\",\n \"auto_add\": true,\n \"targets\": [\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 5096,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 1718,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n }\n ]\n },\n \"errors\": [\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"43wP9331uQT@KjbAzn.lyn\",\n \"component_product_id\": \"80c43459-eb13-575b-7251-975af6089837\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"hOhhSpO@hhraJYLXVTNEXtoEMNbzOaS.xj\",\n \"component_product_id\": \"e13735ed-1890-e5a1-84ac-d95dae7cd7cb\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4a90958-101a-481f-ab6c-46ec758df6c0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" } ] }, "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 \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"76746981-f63a-45f4-ba9e-59773d89dc2e\",\n \"custom_inputs\": {\n \"personalization\": \"My personal message\"\n },\n \"quantity\": 2\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The existing shipping group uses USD, cannot add this shipping group to a cart item with currency GBP\",\n \"meta\": {\n \"item_ids\": [\n \"51197fc0-e217-4f69-a769-b3887f58cfff\"\n ],\n \"shipping_group_id\": \"fcb87ec9-a7fb-48c2-bcd9-2151b64e1abc\"\n },\n \"status\": 404,\n \"title\": \"Cart Currency Mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a48807-cd9d-4517-a6bc-79edc19b4ac0", "name": "Unauthorized call", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" } ] }, "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 \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"76746981-f63a-45f4-ba9e-59773d89dc2e\",\n \"custom_inputs\": {\n \"personalization\": \"My personal message\"\n },\n \"quantity\": 2\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"No permissions to fulfill this request with cart item custom_attributes\",\n \"meta\": {\n \"id\": \"76746981-f63a-45f4-ba9e-59773d89dc2e\"\n },\n \"status\": 403,\n \"title\": \"Unauthorised call\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52a9475d-d583-471e-9565-1b572cd73784", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier of the cart that you created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" } ] }, "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 \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"76746981-f63a-45f4-ba9e-59773d89dc2e\",\n \"custom_inputs\": {\n \"personalization\": \"My personal message\"\n },\n \"quantity\": 2\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Shipping groups not found for this cart. Please verify the shipping groups exists for this cart and are not already associated with orders.\",\n \"meta\": {\n \"cart_id\": \"a-cart-id\",\n \"shipping_group_ids\": [\n \"fcb87ec9-a7fb-48c2-bcd9-2151b64e1abc\"\n ]\n },\n \"status\": 404,\n \"title\": \"Shipping groups not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b42fc3b-4cc8-4415-b59c-56dd1f6bb660", "name": "Delete a Cart Item", "request": { "name": "Delete a Cart Item", "description": { "content": "Use this endpoint to delete a cart item.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart created by you.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "cartitemID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you want to delete.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "28205a3f-93cd-44d4-a169-b6072598f4fb", "name": "200", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart created by you.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart that you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" } ] }, "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": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"078ed2f1-5022-4907-a408-514c7385b986\",\n \"type\": \"subscription_item\",\n \"product_id\": \"1e23b037-3721-7762-c77d-0d95d5a75a7d\",\n \"promotion_id\": \"b41218eb-59a4-9a1b-5871-6d2796bedf45\",\n \"subscription_offering_id\": \"dd44ed17-7154-5452-23f0-89bc5a7c6d0b\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"sku\": \"string\",\n \"slug\": \"string\",\n \"catalog_id\": \"c0172d50-51b6-d7de-aafb-f5f1261b76d3\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 3980.4715976331217,\n \"key_1\": 7090.40319613179\n },\n \"key_1\": {\n \"key_0\": 3273.7054528012764,\n \"key_1\": 9874.471738983393,\n \"key_2\": 9937.150435938296,\n \"key_3\": 3255.581529895155\n },\n \"key_2\": {\n \"key_0\": 7623.412623282961,\n \"key_1\": 9296.529898564426\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 9333\n },\n \"meta\": {\n \"key_0\": 2557,\n \"key_1\": 644,\n \"key_2\": false,\n \"key_3\": true\n },\n \"price\": {\n \"key_0\": true,\n \"key_1\": true\n },\n \"relationships\": {\n \"key_0\": \"string\",\n \"key_1\": 1489\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 4775,\n \"key_1\": 3712\n },\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n \"price\": {\n \"key_0\": true,\n \"key_1\": 7555\n },\n \"relationships\": {\n \"key_0\": 3901\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 2600.204109179576,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6274.233585542963,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"image\": {\n \"mime_type\": \"string\",\n \"file_name\": \"string\",\n \"href\": \"string\"\n },\n \"quantity\": 2468,\n \"auto_add_quantity\": 1557,\n \"manage_stock\": false,\n \"unit_price\": {\n \"amount\": 424.9725584636099,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"value\": {\n \"amount\": 6130.579766004249,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 5405,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 4180\n },\n {\n \"amount\": {\n \"amount\": 1338,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 7940\n }\n ],\n \"custom_inputs\": {\n \"key_0\": 1536\n },\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n },\n \"links\": {\n \"product\": \"string\",\n \"subscription_offering\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 7330.311576442712,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 3249.5945954493677,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 5165.954238490626,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 2835.6416846369693,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 8785.696768971518,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9246.443082106225,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 3572.312488838183,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 8514.380796693456,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 1910.8252194475695,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6752.794978681205,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 4522.402578577507,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 3217.2628247880543,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 4197,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 6880.937191587053,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 6691.3123421874125,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_2\": {\n \"amount\": 1797.920066572345,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 64,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 1070.338222296643,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_2\": {\n \"amount\": 2503,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 7708.9945502570245,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 3818.7615150293386,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"taxes\": {\n \"data\": null\n },\n \"custom_discounts\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"rule-promotion\",\n \"location\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"integer\",\n \"value\": 6653.204224694276\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": true\n }\n }\n },\n {\n \"id\": \"ca002dab-2cfe-42d9-cb20-1d5e9391198b\",\n \"type\": \"promotion_item\",\n \"product_id\": \"f5a74e25-6b7e-43e6-7bc1-00017121f2b9\",\n \"promotion_id\": \"cb92d20f-2ce6-5965-890e-f62a97f5906d\",\n \"subscription_offering_id\": \"e7a77288-7d23-8298-b138-167511ed3f06\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"sku\": \"string\",\n \"slug\": \"string\",\n \"catalog_id\": \"1e9df964-540b-acbc-3e87-19f8bd727a45\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 9982.047495830315,\n \"key_1\": 8704.791433736802\n },\n \"key_1\": {\n \"key_0\": 7341.938358960762\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 7776.105163269273,\n \"key_1\": 6011,\n \"key_2\": 6382.086323475615\n },\n \"meta\": {\n \"key_0\": 972.8975874301726,\n \"key_1\": true\n },\n \"price\": {\n \"key_0\": false\n },\n \"relationships\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": true\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 5916,\n \"key_1\": \"string\"\n },\n \"meta\": {\n \"key_0\": \"string\"\n },\n \"price\": {\n \"key_0\": \"string\"\n },\n \"relationships\": {\n \"key_0\": 1571.9291599128526,\n \"key_1\": 3414\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 1629.0419925126453,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6707.431053307635,\n \"type\": \"string\"\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 3778.9012281177793,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 3342.9844942754785,\n \"type\": \"string\"\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 713.3330258875347,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6811.604699499682,\n \"type\": \"string\"\n }\n ]\n },\n \"key_3\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 5716.169041691947,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 804.1635488183108,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"image\": {\n \"mime_type\": \"string\",\n \"file_name\": \"string\",\n \"href\": \"string\"\n },\n \"quantity\": 4803,\n \"auto_add_quantity\": 6733,\n \"manage_stock\": true,\n \"unit_price\": {\n \"amount\": 1865.9405501705662,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 3873.851395169332,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 8036,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 917\n },\n {\n \"amount\": {\n \"amount\": 2747,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 1157\n }\n ],\n \"custom_inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 2393\n },\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n },\n \"links\": {\n \"product\": \"string\",\n \"subscription_offering\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 614.7948874772413,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 257.0504390227879,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 5827.422689856075,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7998.604845948583,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 1315.275625045247,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6079.070213312889,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 2462.0141925262005,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 1587.299622764191,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 2290.81788652725,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 5792.548399738244,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 8347.770908135388,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9602.475789341544,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 4761,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 8929.563462207929,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 1867.8948820758467,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 776,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 451.25290348307925,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 7978.805341828472,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_2\": {\n \"amount\": 3128,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 3776.4701182726744,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 3602.1480261382235,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"taxes\": {\n \"data\": null\n },\n \"custom_discounts\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"rule-promotion\",\n \"location\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"float\",\n \"value\": \"string\"\n },\n \"key_1\": {\n \"type\": \"float\",\n \"value\": true\n }\n }\n }\n ],\n \"included\": {\n \"custom_discounts\": [\n {\n \"type\": \"string\",\n \"id\": \"19e7e426-09ec-b8d5-a8b3-72b814d2bf03\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 9662.68439122609,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"3088b6ce-b002-8b25-6fb9-6c513a13d77d\",\n \"type\": \"cart_item\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"25f8822a-40ce-a8dd-a9a0-2c349df90be1\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 5055.205809267382,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"6a526abb-3059-c8b0-fd2b-778cc2ac5432\",\n \"type\": \"custom_item\"\n }\n }\n }\n }\n ],\n \"promotions\": [\n {\n \"automatic\": true,\n \"description\": \"string\",\n \"end\": \"2026-04-21T17:45:18.927Z\",\n \"id\": \"e23f0bd3-a6cd-28f5-1567-c5f27ef0dd24\",\n \"name\": \"string\",\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1990-12-23T12:56:00.821Z\",\n \"type\": \"string\"\n },\n {\n \"automatic\": false,\n \"description\": \"string\",\n \"end\": \"2008-05-08T00:04:16.923Z\",\n \"id\": \"fd756cea-71ff-6803-3709-55b571d8363d\",\n \"name\": \"string\",\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1977-06-17T19:42:42.966Z\",\n \"type\": \"string\"\n }\n ],\n \"tax_items\": [\n {\n \"type\": \"string\",\n \"id\": \"0ebb2b40-cdf5-c0fb-76d8-e1113aff3ab0\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 1928.1541725686814,\n \"amount\": 4737\n },\n {\n \"type\": \"string\",\n \"id\": \"926f2939-2000-3f12-56c6-c299b2b260a3\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 8173.347654185978,\n \"amount\": 6174\n }\n ]\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 9632.074933726168,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 2345.6164216474494,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 9747.443269518571,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 406.79962394889026,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 3672.301263491875,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 1380.8233159755523,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 930.1283379158854,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 7218.650503174349,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 6713.1083480602265,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 3226.487255377708,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"expires_at\": \"string\"\n },\n \"messages\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"source\": {\n \"type\": \"string\",\n \"id\": \"string\",\n \"code\": \"string\"\n }\n },\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"source\": {\n \"type\": \"string\",\n \"id\": \"string\",\n \"code\": \"string\"\n }\n }\n ],\n \"promotion_suggestions\": [\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 4941,\n \"targets\": [\n \"string\",\n \"string\"\n ],\n \"key_0\": 7687.4568012811715,\n \"key_1\": 4604.036881925933\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 8390,\n \"targets\": [\n \"string\",\n \"string\"\n ],\n \"key_0\": 7169.379488994059\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\",\n \"auto_add\": true,\n \"targets\": [\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 1746,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 7763,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n },\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 1538,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 8885,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\",\n \"auto_add\": true,\n \"targets\": [\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 5096,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"cart_item_id\": \"string\",\n \"quantity\": 1718,\n \"skus\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n }\n ]\n },\n \"errors\": [\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"43wP9331uQT@KjbAzn.lyn\",\n \"component_product_id\": \"80c43459-eb13-575b-7251-975af6089837\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"hOhhSpO@hhraJYLXVTNEXtoEMNbzOaS.xj\",\n \"component_product_id\": \"e13735ed-1890-e5a1-84ac-d95dae7cd7cb\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef1a0a1c-cb64-4ec0-a4fd-1911b77193d7", "name": "Delete a Promotion via Promotion Code", "request": { "name": "Delete a Promotion via Promotion Code", "description": { "content": "You can remove promotion code from a cart if it was applied manually. This endpoint does not work if the promotion is applied automatically.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "discounts", ":promoCode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) Specifies the unique identifier of a cart created by you.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "promoCode", "disabled": false, "description": { "content": "(Required) Specifies the promotion code to be deleted.", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "cc177266-df7b-405b-a8dd-47b5c4f101fd", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "discounts", ":promoCode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the unique identifier of a cart created by you.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) Specifies the promotion code to be deleted.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promoCode" } ] }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Checkout", "description": "\nThe checkout workflow ties together many of the key concepts covered in this section. When a customer initiates the checkout process, an order is created from the cart. The order is incomplete until after a successful payment is made. A complete order can be shipped and the product deducted from inventory counts.\n\n![Checkout workflow](/assets/checkout-flow.png)\n\n### Summary of the checkout workflow\n\n1. Add a product to a cart. A cart and its reference number is generated.\n2. Manage the cart items. For example, you might add items, remove items, and change quantities.\n3. Check out the cart. An incomplete order is created.\n4. Pay for an order: provide billing and shipping details, if you are a new customer. The order is now in the processing status.\n5. If using a manual gateway, after you authorize and capture it, Composable Commerce considers the order complete. If you use a third-party integration supported by Composable Commerce (such as Stripe), after the third-party gateway authorizes and captures the payment, the order becomes complete. Usually capture does not occur at the same time as authorization. For more information, see the Capture section.\n6. After the order is shipped, you can manually flag it as fulfilled.\n\n### Carts\n\nWhen a product is added to a cart, a cart is generated together with its unique reference ID that on checkout becomes a part of the order ID. If you are using our JavaScript software development kit, generating a cart reference ID is done for you; otherwise, add a cart reference generator to your functionality.\n\n### Promotions and custom items\n\nOptionally, apply a promotion code on a cart, or add custom_items to modify the product price (typically to handle taxes, customs, or shipping).\n\n### Checkout\n\nYou can checkout a cart with an associated customer name and email (customer object). Typically, this would be used for new customers or ones that prefer to shop as guests. Use the `customer.id` checkout option to checkout for an existing customer. After a successful checkout is completed, the response contains an order.\n\nEmail addresses that either begin or end with a period, or contain consecutive periods, are considered invalid, resulting in the following error:\n```json\n\"errors\": [\n {\n \"status\": 400,\n \"source\": \"data.customer.email\",\n \"title\": \"format\",\n \"detail\": \"Does not match format 'email'\"\n }\n]\n ```\n\n### Payments\n\nOn checkout, an incomplete order is created. You can then use a third-party integration to handle your payment gateway. If the payment gateway is supported by Composable Commerce, such as Stripe, the payment is processed externally but handled internally. When a successful validation is returned, Composable Commerce flags the order as complete.\n\nIf you are using a payment method not officially supported by Composable Commerce, the gateway needs to be implemented and handled manually. After the payment has been authorized and captured either through Commerce Manager or API, the status of an order becomes complete.\n\n### Shipping\n\nThe status of an order and the status of shipping are handled separately, and so an order can be complete but not shipped. Orders that have not been shipped yet have a status of unfulfilled. This flag is generated automatically by Composable Commerce when an order is created. Currently, you can only update the shipping status manually, through the API. After the order is shipped, flag its shipping status as fulfilled.\n\n### Inventory\n\nIf enabled, you can manage your stock. As such, your stock is automatically updated as soon as a product is checked out.\n", "item": [ { "id": "056bb0c9-d43f-4290-9930-2818e1f532e4", "name": "Checkout API", "request": { "name": "Checkout API", "description": { "content": "When a Cart is ready for checkout, you can convert the cart to an order. The cart remains and can be modified and checked out again if required.\n\nA cart can be checked out with a customer ID, customer object, or with an account by authenticating with the `Client Credentials Token`.\n\nAfter a successful checkout, a response that contains the order is returned. If the cart is linked to a shipping group, the shipping group is also associated with the order after checkout.\n\nYou can checkout using one of the following methods:\n- **Customer ID**: You can checkout a cart with an existing customer ID.\n- **Guest Checkout** (Checkout with Customer Object): You can checkout a cart with an associated customer name and email.\n- **Checkout with Account**: The shopper authenticates with the `Client Credentials` Token.\n- **Checkout with Account Management Authentication Token**: The shopper authenticates with the `Implicit Token` and the `EP-Account-Management-Authentication-Token`.\n\n:::note\n\n- The cart currency is set when the first item is added to the cart.\n- The product being added to the cart requires a price in the same currency as the other items in the cart. The API returns a 400 error if a price is not defined in the correct currency.\n- To ensure that a free gift is automatically applied to an order, set the promotion to automatic. The checkout process will not be successful if free gift items are out of stock. See [Errors](#errors) section.\n\n:::\n\n:::caution\n\n- By default, carts are automatically deleted 7 days after the last update. You can change this setting by [updating cart settings](/docs/api/carts/put-v-2-settings-cart).\n- Your inventory is modified during checkout and payment of an order. For more information about the changes in the inventory, see the [Inventory](/docs/api/pxm/inventory/inventories-introduction) section.\n\n:::\n\n You can pass `order_number` and `external_ref` in the checkout endpoint or when [updating an order](/docs/api/carts/update-an-order). The `order_number` is an optional, user-managed field that is used as an alternative to `order_id`. When processing transactions through Authorize.net, the `order_number` is sent instead of the `order_id`, and it will appear in the invoice number section. If no `order_number` is provided, the `order_id` is sent to Authorize.net on payment by default. There are no duplication restrictions on the `order_number` value.\n\n### Next Steps\n\nAfter a cart has been converted to an Order using either of the previous methods, you most likely want to capture payment for order. See [Paying for an Order](/docs/api/carts/payments).\n\n### Errors\n\nThe following error response is returned during checkout when an eligible item is added to the cart, and the free gift is out of stock.\n\n```json\n{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Insufficient stock\",\n \"detail\": \"There is not enough stock to add gift2 to your cart\",\n \"meta\": {\n \"id\": \"f2b68648-9621-45a3-aed6-1b526b0f5beb\",\n \"sku\": \"gift2\"\n }\n }\n ]\n}\n```\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The ID of the cart that you want to checkout.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "An account management authentication token that identifies the authenticated account member.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"order_number\": \"order-1234\",\n \"external_ref\": \"e-123456789\",\n \"customer\": {\n \"id\": \"c8c1c511-beef-4812-9b7a-9f92c587217c\"\n },\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company_name\": \"Moltin\",\n \"line_1\": \"1234 Disney Drive\",\n \"line_2\": \"Disney Resort\",\n \"city\": \"Anaheim\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postcode\": \"92802\",\n \"country\": \"US\"\n },\n \"shipping_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"Moltin\",\n \"line_1\": \"1234 Disney Drive\",\n \"line_2\": \"Disney Resort\",\n \"city\": \"Anaheim\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postcode\": \"92802\",\n \"country\": \"US\",\n \"instructions\": \"Leave in porch\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3796c1ea-6f25-48c6-a0ac-8ed80a5bb6a5", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart that you want to checkout.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "An account management authentication token that identifies the authenticated account member.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "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 \"data\": {\n \"order_number\": \"order-1234\",\n \"external_ref\": \"e-123456789\",\n \"customer\": {\n \"id\": \"c8c1c511-beef-4812-9b7a-9f92c587217c\"\n },\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company_name\": \"Moltin\",\n \"line_1\": \"1234 Disney Drive\",\n \"line_2\": \"Disney Resort\",\n \"city\": \"Anaheim\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postcode\": \"92802\",\n \"country\": \"US\"\n },\n \"shipping_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"Moltin\",\n \"line_1\": \"1234 Disney Drive\",\n \"line_2\": \"Disney Resort\",\n \"city\": \"Anaheim\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postcode\": \"92802\",\n \"country\": \"US\",\n \"instructions\": \"Leave in porch\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"order_number\": \"string\",\n \"external_ref\": \"string\",\n \"id\": \"d323feba-cf89-664b-750e-5c44be4e8edd\",\n \"status\": \"incomplete\",\n \"payment\": \"partially_authorized\",\n \"shipping\": \"fulfilled\",\n \"anonymized\": false,\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": 372.523300825911\n }\n },\n \"links\": {},\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"fully_paid_at\": \"string\"\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3464.8629959143527,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 367.98239184148593,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 1232.1274888624,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 6141.193879104563,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 1270.895924320834,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 8943.710159647117,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 8915.810761731836,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 5609.7618722005445,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"is_manual\": false\n },\n \"billing_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\"\n },\n \"contact\": {\n \"email\": \"string\",\n \"name\": \"string\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"mGHb3G6Wl@qamghxFylSZNotUSqY.ruja\",\n \"id\": \"aabedb25-a113-0e6a-a482-a148958809bf\"\n },\n \"shipping_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"relationships\": {\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"344ee6b7-d95a-e715-f0db-a22b7fd61e82\"\n },\n {\n \"type\": \"string\",\n \"id\": \"ab10e21e-cefc-5451-d135-21ba5472b35b\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"9250f981-fb69-25ac-f125-ba1a8d01b0be\"\n },\n {\n \"type\": \"string\",\n \"id\": \"41a9cfab-68b5-d653-5b61-0a56559a6e18\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"7623a0a6-8262-53f2-d668-71062f4f5316\"\n },\n {\n \"type\": \"string\",\n \"id\": \"08313209-73cf-9f72-6e2c-59259fa5b832\"\n }\n ]\n },\n \"customer\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"af663ae1-0d6b-db5b-7ac0-c513c130c42e\"\n }\n },\n \"account\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"dd95f042-eb9b-88ae-61d5-5515c10f4d32\"\n }\n },\n \"account_member\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"2c4c6b7e-0245-eccb-37aa-5aec7e0dac38\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"e0a869ac-ffc4-0dff-8355-9b56e8b74cf4\"\n }\n }\n }\n },\n \"included\": {\n \"items\": [\n {\n \"type\": \"string\",\n \"id\": \"3200a925-1525-6f35-a1ec-f278c9163801\",\n \"quantity\": 8909.363975818273,\n \"product_id\": \"c757785c-48bd-8a59-d1ab-15d3e74e62e2\",\n \"subscription_offering_id\": \"1e1b19a3-ce45-ceae-7865-b64b52415d45\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"location\": \"string\",\n \"unit_price\": {\n \"amount\": 5398.222804432693,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 3160.7786264801407,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 7723.893911593948,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"code\": \"string\",\n \"id\": \"b1743990-9d4f-3d50-655f-fab848ed73ed\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 5452\n },\n {\n \"amount\": {\n \"amount\": 4584.871041996142,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"code\": \"string\",\n \"id\": \"ba59cda8-2380-9080-68b0-f8ea2c38f6d2\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 9304\n }\n ],\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 4401.870186780785,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4383.530125713446,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 7695.775225820343,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 721.9307559551091,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 7664.028862419376,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6158.174407411485,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 4797.1997190235215,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 3429.3500765661265,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 588.9560598956845,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 8559.919948924537,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 3639.6162694267,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 3674.390162428187,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 9812.818248358233,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_2\": {\n \"amount\": 4468.401819186465,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_3\": {\n \"amount\": 9261.202622939694,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 6900.666465076098,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4375.8283106430445,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"cart_item\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"81260321-2b87-f0d2-9bc2-2bb6c47c58d4\"\n }\n },\n \"taxes\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"catalog_id\": \"string\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 5509.714120653497\n },\n \"key_1\": {\n \"key_0\": 4082.9502145839515\n },\n \"key_2\": {\n \"key_0\": 254.9414521778881,\n \"key_1\": 2505.0406434319216\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 8138.5648564450585\n },\n \"meta\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": 7375\n },\n \"price\": {\n \"key_0\": 1485.178044525559,\n \"key_1\": false\n },\n \"relationships\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 4554,\n \"key_1\": true,\n \"key_2\": 5902.734773436655\n },\n \"meta\": {\n \"key_0\": 842.7616813869432,\n \"key_1\": \"string\"\n },\n \"price\": {\n \"key_0\": false\n },\n \"relationships\": {\n \"key_0\": false\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 2218.6773557181705,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 9518.477544462707,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": \"string\"\n },\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"integer\",\n \"value\": 8758.399140270674\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"string\",\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"bf2a8333-00c4-af29-0b66-1fd333267cf4\",\n \"quantity\": 5772.3410478429105,\n \"product_id\": \"c4fff3ab-dbb9-4121-14cf-2b7f7a3438e7\",\n \"subscription_offering_id\": \"73720617-f008-4757-69cf-d0071beff8e9\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"location\": \"string\",\n \"unit_price\": {\n \"amount\": 2287.1295568312157,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 959.3302193705177,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 6443.6568061889975,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"code\": \"string\",\n \"id\": \"83b5470a-f362-054d-81de-61a3af86dc62\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 9281\n },\n {\n \"amount\": {\n \"amount\": 8179.368039872925,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"code\": \"string\",\n \"id\": \"94c05c1e-9e20-3b04-5fc7-ec29cfc29375\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 3829\n }\n ],\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 1240.785478584112,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 1303.24736875977,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 1478.3483563332634,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9333.654371245575,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 6724.54517149389,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4637.4020830106265,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 7459.364194939868,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6370.629765223699,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 2177.868005315262,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9729.961357080449,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 1329.0871601378828,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 3878.599332265682,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 7716.373585352827,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_2\": {\n \"amount\": 8076.098308055431,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 8346.884182218122,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 9372.557054015491,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 7708.372468726739,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 5343.028673516687,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 5313.930381539245,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"cart_item\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"bf395c80-1662-dbc2-2024-69b2fe972eb5\"\n }\n },\n \"taxes\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"catalog_id\": \"string\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 6998.1419242093225,\n \"key_1\": 8939.646245425154\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 3354,\n \"key_1\": 6314,\n \"key_2\": 8537\n },\n \"meta\": {\n \"key_0\": 1352.5710172064298,\n \"key_1\": 7181.341598620241\n },\n \"price\": {\n \"key_0\": false,\n \"key_1\": 1712.7866656570022,\n \"key_2\": 7490\n },\n \"relationships\": {\n \"key_0\": \"string\",\n \"key_1\": 4563.852831809738,\n \"key_2\": 9456.32119817703\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": true\n },\n \"meta\": {\n \"key_0\": 779.1403012262222\n },\n \"price\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 28.13164969440063\n },\n \"relationships\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 536.9649963041168,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6871.369035567512,\n \"type\": \"string\"\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 4544.087400097556,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 2173.2562321541905,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": \"string\"\n },\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": 6231.408027255953\n },\n \"key_1\": {\n \"type\": \"float\",\n \"value\": false\n },\n \"key_2\": {\n \"type\": \"integer\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"string\",\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n }\n }\n ],\n \"tax_items\": [\n {\n \"type\": \"string\",\n \"id\": \"ca238420-4f24-f74f-d0d3-fe0125066696\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 3017.3432423235467,\n \"amount\": 6069\n },\n {\n \"type\": \"string\",\n \"id\": \"638acf01-9f1c-a86f-b467-52b13524795a\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 2470.197233995308,\n \"amount\": 6195\n }\n ],\n \"custom_discounts\": [\n {\n \"type\": \"string\",\n \"id\": \"e33ed5e4-3bc4-5884-b546-1132893056d2\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 8122.735718157954,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"fc4e43ea-be2c-322b-4dd0-ccccca8dd49d\",\n \"type\": \"cart_item\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"4eade358-2e2e-2eb8-b419-fc86305d37d1\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 7085.643168088125,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"0d47bf76-a999-e1fb-78fd-97e333ae9ef5\",\n \"type\": \"cart_item\"\n }\n }\n }\n }\n ],\n \"promotions\": [\n {\n \"type\": \"string\",\n \"id\": \"2420ab2b-ed39-9c6a-9f10-215c72e69b1e\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"2011-04-09T15:28:37.828Z\",\n \"end\": \"1963-03-30T21:09:24.063Z\"\n },\n {\n \"type\": \"string\",\n \"id\": \"ef4014d4-2acb-fd1b-5713-ab077850e97e\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"2018-07-17T00:17:44.721Z\",\n \"end\": \"1985-03-30T05:04:26.079Z\"\n }\n ]\n },\n \"errors\": [\n {\n \"status\": 1294,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"3D8ZnuH@ZTnltIcTKPsIeaOTXnqmNBsNegOfEcESY.rug\",\n \"component_product_id\": \"d596f5b5-b243-b5fd-7767-23540042214a\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 2452,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"e1f9EBhCYbW717o@GnmeZYHyRWMnqEyGSOoN.ene\",\n \"component_product_id\": \"aed82fd7-0a65-4820-0d77-31dadf4647e1\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c35646c-bc56-43ef-a063-21ef14220700", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart that you want to checkout.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "An account management authentication token that identifies the authenticated account member.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "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 \"data\": {\n \"order_number\": \"order-1234\",\n \"external_ref\": \"e-123456789\",\n \"customer\": {\n \"id\": \"c8c1c511-beef-4812-9b7a-9f92c587217c\"\n },\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company_name\": \"Moltin\",\n \"line_1\": \"1234 Disney Drive\",\n \"line_2\": \"Disney Resort\",\n \"city\": \"Anaheim\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postcode\": \"92802\",\n \"country\": \"US\"\n },\n \"shipping_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"Moltin\",\n \"line_1\": \"1234 Disney Drive\",\n \"line_2\": \"Disney Resort\",\n \"city\": \"Anaheim\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postcode\": \"92802\",\n \"country\": \"US\",\n \"instructions\": \"Leave in porch\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ad3609e-9eb9-4f11-a66b-6bac0b483eed", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart that you want to checkout.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "header": [ { "disabled": false, "description": { "content": "An account management authentication token that identifies the authenticated account member.", "type": "text/plain" }, "key": "EP-Account-Management-Authentication-Token", "value": "{{accountToken}}" }, { "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 \"data\": {\n \"order_number\": \"order-1234\",\n \"external_ref\": \"e-123456789\",\n \"customer\": {\n \"id\": \"c8c1c511-beef-4812-9b7a-9f92c587217c\"\n },\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company_name\": \"Moltin\",\n \"line_1\": \"1234 Disney Drive\",\n \"line_2\": \"Disney Resort\",\n \"city\": \"Anaheim\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postcode\": \"92802\",\n \"country\": \"US\"\n },\n \"shipping_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"Moltin\",\n \"line_1\": \"1234 Disney Drive\",\n \"line_2\": \"Disney Resort\",\n \"city\": \"Anaheim\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postcode\": \"92802\",\n \"country\": \"US\",\n \"instructions\": \"Leave in porch\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Orders", "description": "An Order is created through the [checkout](/docs/api/carts/checkout) endpoint within the Carts API.\n\nAn order is created after a customer checks out their cart. On creation, the order is marked unpaid. The customer is prompted for a shipping address, a billing address, and a payment method. After the order is successfully paid, you can trigger an inventory process and a shipping process.\n\nYou can keep a history of orders associated with the customer account.\n\n### Reorder\n\nA re-order is when a shopper copies items from a previous order from their order history into a cart of their choice. If a shopper re-orders to an empty cart, the same quantities as the past order are applied. If the shopper re-orders to an existing cart, and orders the same item, the quantity increases. If an item is out of stock, the item is not added to the cart, and the shopper sees an insufficient stock error. The tax for the items in a re-order is not applied. For more information, see [Tax Items](/docs/api/carts/tax-items).\n", "item": [ { "id": "0e5b19a5-7388-4129-b046-68101bf76b6b", "name": "Get all Orders", "request": { "name": "Get all Orders", "description": { "content": "This endpoint returns all orders with custom flow fields. The pagination offset is set to fetch a maximum of 10,000 orders. If the store has 10,000 orders, and you fetch the orders without using filters, an error is returned. Use a filter to view orders when the order is beyond the 10,000 mark.\n\n:::note\n\n- Pass the `X-Moltin-Customer-Token` header to limit orders to a specific customer. See [Customer Tokens](/docs/customer-management/customer-management-api/customer-tokens).\n- Pass the `EP-Account-Management-Authentication-Token` header to limit orders to a specific account. See [Account Management Token](/docs/api/accounts/post-v-2-account-members-tokens).\n- You can use pagination with this resource. For more information, see [pagination](/guides/Getting-Started/pagination).\n\n:::\n\n### Filtering\n\nThe following operators and attributes are available for filtering orders.\n\n| Attribute | Type | Operator | Example |\n| :--- | :--- | :--- | :--- |\n| `status` | `string` | `eq` | `eq(status,complete)` |\n| `payment` | `string` | `eq` | `eq(payment,paid)` |\n| `shipping` | `string` | `eq` | `eq(shipping,unfulfilled)` |\n| `name` (`customer.name`) | `string` | `eq` / `like` | `like(name,Brad*)` |\n| `email` (`customer.email`) | `string` | `eq` / `like` | `like(email,*@elasticpath.com)` |\n| `customer_id` | `string` | `eq` / `like` | `eq(customer_id, e5a0d684-a4af-4919-a348-f66b0b4955e0)` |\n| `account_id` | `string` | `eq` / `like` | `eq(account_id,3d7200c9-a9bc-4085-9822-63e80fd94a09)` |\n| `account_member_id` | `string` | `eq` / `like` | `eq(account_member_id,2a8a3a92-2ccd-4b2b-a7af-52d3896eaecb)` |\n| `contact.name` | `string` | `eq` / `like` | `eq(name,John Doe)` |\n| `contact.email` | `string` | `eq` / `like` | `eq(email,John Doe)` |\n| `shipping_postcode` | `string` | `eq` / `like` | `like(shipping_postcode,117*)` |\n| `billing_postcode` | `string` | `eq` / `like` | `like(billing_postcode,117*)` |\n| `with_tax` | `integer` | `gt`/`ge`/`lt`/`le` | `ge(with_tax,10000)` |\n| `without_tax` | `integer` | `gt`/`ge`/`lt`/`le` | `ge(without_tax,10000)` |\n| `currency` | `string` | `eq` | `eq(currency,USD)` |\n| `product_id` | `string` | `eq` | `eq(product_id,6837058c-ae42-46db-b3c6-7f01e0c34b40)` |\n| `product_sku` | `string` | `eq` | `eq(product_sku,deck-shoe-001)` |\n| `created_at` | `date` | `eq` / `gt` / `ge`/ `le` / `lt` | `gt(created_at,YYYY-MM-DD)` |\n| `updated_at` | `date` | `eq` / `gt` / `ge`/ `le`/ `lt` | `lt(updated_at,YYYY-MM-DD)` |\n| `external_ref` | `string` | `eq` / `like` | `like(external_ref, 16be*)` |\n| `order_number` | `string` | `eq` / `like` | `like(order_number, 123*)` |\n### Includes\nYou can include related resources with the order response by using the `include` query parameter.\n| Name | Optional | Type | Description | |:-----|:---------|:-----|:------------| | `include` | Optional | `string` | Comma-delimited string of entities that can be included. The information included are `items`, `tax_items`, `custom_discounts`, or `promotions`. |\n", "type": "text/plain" }, "url": { "path": [ "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-delimited string of entities to include (items, tax_items, custom_discounts, promotions).", "type": "text/plain" }, "key": "include", "value": "items" }, { "disabled": false, "description": { "content": "The maximum number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "20" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Filter expression for searching orders. See filtering documentation for available operators and attributes.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A customer token to access a specific customer's orders.", "type": "text/plain" }, "key": "x-moltin-customer-token", "value": "{{customerToken}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "210d7794-09a4-4b4a-8cea-8e8195f31a7a", "name": "200", "originalRequest": { "url": { "path": [ "v2", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-delimited string of entities to include (items, tax_items, custom_discounts, promotions).", "type": "text/plain" }, "key": "include", "value": "items" }, { "disabled": false, "description": { "content": "The maximum number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "20" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Filter expression for searching orders. See filtering documentation for available operators and attributes.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A customer token to access a specific customer's orders.", "type": "text/plain" }, "key": "x-moltin-customer-token", "value": "{{customerToken}}" }, { "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 \"type\": \"string\",\n \"order_number\": \"string\",\n \"external_ref\": \"string\",\n \"id\": \"dd26e6d2-55ab-4ba0-4321-2c07bb2d314b\",\n \"status\": \"complete\",\n \"payment\": \"partially_authorized\",\n \"shipping\": \"unfulfilled\",\n \"anonymized\": false,\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"boolean\",\n \"value\": 2044.1315283056438\n },\n \"key_1\": {\n \"type\": \"integer\",\n \"value\": \"string\"\n }\n },\n \"links\": {},\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"fully_paid_at\": \"string\"\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5529.774141411461,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 4485.340533368989,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 8787.113911017579,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 8794.966605026255,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 520.2526033953814,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 7675.110166633972,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 7919.731979925604,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 322.68080025233957,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"is_manual\": true\n },\n \"billing_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\"\n },\n \"contact\": {\n \"email\": \"string\",\n \"name\": \"string\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"tkXJLHG8SiNTlZ@SaRoeXFLJnxXl.zq\",\n \"id\": \"c31cb082-98a5-a676-bdbb-6269500359d0\"\n },\n \"shipping_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"relationships\": {\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"abd2826b-2061-eec2-8e16-8c3b00537837\"\n },\n {\n \"type\": \"string\",\n \"id\": \"7fc5398d-ba65-ed7e-04e1-cfed10a98248\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"2781aea1-2530-c6cc-1997-d1787736da93\"\n },\n {\n \"type\": \"string\",\n \"id\": \"d05c95f2-705c-ddbb-80f5-0b433a7eb112\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"cb943769-54c7-da57-020a-e19ed8486759\"\n },\n {\n \"type\": \"string\",\n \"id\": \"cb402ab6-7f2d-6579-c7cf-8637a4e1e538\"\n }\n ]\n },\n \"customer\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"1735f16f-1d8a-8539-51a9-e32fcd6b5f6d\"\n }\n },\n \"account\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"2b74fcb3-3c13-bc56-c2ca-b99c20b60ef1\"\n }\n },\n \"account_member\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"a9ecb576-61ff-7cb6-04fa-33e2161e02c8\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"4dd124c3-4074-aa09-72c1-523c3a202fef\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"order_number\": \"string\",\n \"external_ref\": \"string\",\n \"id\": \"a734dde2-9b24-ad84-81c1-ba3f1c4d9e8e\",\n \"status\": \"complete\",\n \"payment\": \"refunded\",\n \"shipping\": \"fulfilled\",\n \"anonymized\": false,\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": 9567.162702704898\n },\n \"key_1\": {\n \"type\": \"boolean\",\n \"value\": false\n }\n },\n \"links\": {},\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"fully_paid_at\": \"string\"\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3213.669452448782,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 8176.776296711146,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 1234.4842985824966,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 414.056565415053,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 2351.0874299146735,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 9325.120395654794,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 1826.9660955952284,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 2937.4411801700794,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"is_manual\": false\n },\n \"billing_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\"\n },\n \"contact\": {\n \"email\": \"string\",\n \"name\": \"string\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"TWeLEtVNWJ@uWqEHoKkPW.snus\",\n \"id\": \"a3aba08c-fd7e-65da-8369-3e1d03ba6df9\"\n },\n \"shipping_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"relationships\": {\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"4b18899e-2536-d00a-f088-ed94a6586159\"\n },\n {\n \"type\": \"string\",\n \"id\": \"769c1228-0d9d-bb15-96d8-0c93036f322b\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"030cac1a-335d-e848-a405-80071dfd9d65\"\n },\n {\n \"type\": \"string\",\n \"id\": \"b2645e31-726f-dfb8-604b-1ac7cdaf5459\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"3f789cb6-b57b-d658-e296-686b3585869c\"\n },\n {\n \"type\": \"string\",\n \"id\": \"4da9f59b-0ea0-4e5d-6c78-cd947ce5a512\"\n }\n ]\n },\n \"customer\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"d48c9195-1de8-381e-9395-2229492f9cc3\"\n }\n },\n \"account\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"f25ca48e-3a39-67d9-8cf9-a33ed03574c6\"\n }\n },\n \"account_member\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"5a080a49-fe7b-652b-ee61-21bda6a64770\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"25adb33e-2093-896a-b343-16ae7a37f3e4\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"current\": \"string\",\n \"first\": \"string\",\n \"last\": \"string\",\n \"next\": \"string\",\n \"prev\": \"string\"\n },\n \"meta\": {\n \"page\": {\n \"current\": 6347,\n \"limit\": 4368,\n \"offset\": 6164,\n \"total\": 7714\n },\n \"results\": {\n \"total\": 2157\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d39baa4-edbc-445c-b319-ceca07511cfb", "name": "Get an Order", "request": { "name": "Get an Order", "description": { "content": "Use this endpoint to retrieve a specific order.\n\n### Includes\n\nYou can include related resources with the order response by using the `include` query parameter.\n\n| Name | Required | Type | Description |\n|:----------|:---------|:---------|:------------|\n| `include` | Optional | `string` | Comma-delimited string of entities that can be included. The included options are `items`, `tax_items`, `custom_discounts`, or `promotions`. |", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-delimited string of entities to include (items, tax_items, custom_discounts, promotions).", "type": "text/plain" }, "key": "include", "value": "items" } ], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The ID of the order.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ce48b5c5-2482-4ac3-afb9-ffff84a94b8d", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-delimited string of entities to include (items, tax_items, custom_discounts, promotions).", "type": "text/plain" }, "key": "include", "value": "items" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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 \"type\": \"string\",\n \"order_number\": \"string\",\n \"external_ref\": \"string\",\n \"id\": \"d323feba-cf89-664b-750e-5c44be4e8edd\",\n \"status\": \"incomplete\",\n \"payment\": \"partially_authorized\",\n \"shipping\": \"fulfilled\",\n \"anonymized\": false,\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": 372.523300825911\n }\n },\n \"links\": {},\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"fully_paid_at\": \"string\"\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3464.8629959143527,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 367.98239184148593,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 1232.1274888624,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 6141.193879104563,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 1270.895924320834,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 8943.710159647117,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 8915.810761731836,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 5609.7618722005445,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"is_manual\": false\n },\n \"billing_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\"\n },\n \"contact\": {\n \"email\": \"string\",\n \"name\": \"string\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"mGHb3G6Wl@qamghxFylSZNotUSqY.ruja\",\n \"id\": \"aabedb25-a113-0e6a-a482-a148958809bf\"\n },\n \"shipping_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"relationships\": {\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"344ee6b7-d95a-e715-f0db-a22b7fd61e82\"\n },\n {\n \"type\": \"string\",\n \"id\": \"ab10e21e-cefc-5451-d135-21ba5472b35b\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"9250f981-fb69-25ac-f125-ba1a8d01b0be\"\n },\n {\n \"type\": \"string\",\n \"id\": \"41a9cfab-68b5-d653-5b61-0a56559a6e18\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"7623a0a6-8262-53f2-d668-71062f4f5316\"\n },\n {\n \"type\": \"string\",\n \"id\": \"08313209-73cf-9f72-6e2c-59259fa5b832\"\n }\n ]\n },\n \"customer\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"af663ae1-0d6b-db5b-7ac0-c513c130c42e\"\n }\n },\n \"account\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"dd95f042-eb9b-88ae-61d5-5515c10f4d32\"\n }\n },\n \"account_member\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"2c4c6b7e-0245-eccb-37aa-5aec7e0dac38\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"e0a869ac-ffc4-0dff-8355-9b56e8b74cf4\"\n }\n }\n }\n },\n \"included\": {\n \"items\": [\n {\n \"type\": \"string\",\n \"id\": \"3200a925-1525-6f35-a1ec-f278c9163801\",\n \"quantity\": 8909.363975818273,\n \"product_id\": \"c757785c-48bd-8a59-d1ab-15d3e74e62e2\",\n \"subscription_offering_id\": \"1e1b19a3-ce45-ceae-7865-b64b52415d45\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"location\": \"string\",\n \"unit_price\": {\n \"amount\": 5398.222804432693,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 3160.7786264801407,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 7723.893911593948,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"code\": \"string\",\n \"id\": \"b1743990-9d4f-3d50-655f-fab848ed73ed\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 5452\n },\n {\n \"amount\": {\n \"amount\": 4584.871041996142,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"code\": \"string\",\n \"id\": \"ba59cda8-2380-9080-68b0-f8ea2c38f6d2\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 9304\n }\n ],\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 4401.870186780785,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4383.530125713446,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 7695.775225820343,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 721.9307559551091,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 7664.028862419376,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6158.174407411485,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 4797.1997190235215,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 3429.3500765661265,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 588.9560598956845,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 8559.919948924537,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 3639.6162694267,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 3674.390162428187,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 9812.818248358233,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_2\": {\n \"amount\": 4468.401819186465,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_3\": {\n \"amount\": 9261.202622939694,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 6900.666465076098,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4375.8283106430445,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"cart_item\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"81260321-2b87-f0d2-9bc2-2bb6c47c58d4\"\n }\n },\n \"taxes\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"catalog_id\": \"string\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 5509.714120653497\n },\n \"key_1\": {\n \"key_0\": 4082.9502145839515\n },\n \"key_2\": {\n \"key_0\": 254.9414521778881,\n \"key_1\": 2505.0406434319216\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 8138.5648564450585\n },\n \"meta\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": 7375\n },\n \"price\": {\n \"key_0\": 1485.178044525559,\n \"key_1\": false\n },\n \"relationships\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 4554,\n \"key_1\": true,\n \"key_2\": 5902.734773436655\n },\n \"meta\": {\n \"key_0\": 842.7616813869432,\n \"key_1\": \"string\"\n },\n \"price\": {\n \"key_0\": false\n },\n \"relationships\": {\n \"key_0\": false\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 2218.6773557181705,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 9518.477544462707,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": \"string\"\n },\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"integer\",\n \"value\": 8758.399140270674\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"string\",\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"bf2a8333-00c4-af29-0b66-1fd333267cf4\",\n \"quantity\": 5772.3410478429105,\n \"product_id\": \"c4fff3ab-dbb9-4121-14cf-2b7f7a3438e7\",\n \"subscription_offering_id\": \"73720617-f008-4757-69cf-d0071beff8e9\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"location\": \"string\",\n \"unit_price\": {\n \"amount\": 2287.1295568312157,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 959.3302193705177,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 6443.6568061889975,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"code\": \"string\",\n \"id\": \"83b5470a-f362-054d-81de-61a3af86dc62\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 9281\n },\n {\n \"amount\": {\n \"amount\": 8179.368039872925,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"code\": \"string\",\n \"id\": \"94c05c1e-9e20-3b04-5fc7-ec29cfc29375\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 3829\n }\n ],\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 1240.785478584112,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 1303.24736875977,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 1478.3483563332634,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9333.654371245575,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 6724.54517149389,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4637.4020830106265,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 7459.364194939868,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6370.629765223699,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 2177.868005315262,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9729.961357080449,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 1329.0871601378828,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 3878.599332265682,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 7716.373585352827,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_2\": {\n \"amount\": 8076.098308055431,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 8346.884182218122,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 9372.557054015491,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 7708.372468726739,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 5343.028673516687,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 5313.930381539245,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"cart_item\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"bf395c80-1662-dbc2-2024-69b2fe972eb5\"\n }\n },\n \"taxes\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"catalog_id\": \"string\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 6998.1419242093225,\n \"key_1\": 8939.646245425154\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 3354,\n \"key_1\": 6314,\n \"key_2\": 8537\n },\n \"meta\": {\n \"key_0\": 1352.5710172064298,\n \"key_1\": 7181.341598620241\n },\n \"price\": {\n \"key_0\": false,\n \"key_1\": 1712.7866656570022,\n \"key_2\": 7490\n },\n \"relationships\": {\n \"key_0\": \"string\",\n \"key_1\": 4563.852831809738,\n \"key_2\": 9456.32119817703\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": true\n },\n \"meta\": {\n \"key_0\": 779.1403012262222\n },\n \"price\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 28.13164969440063\n },\n \"relationships\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 536.9649963041168,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6871.369035567512,\n \"type\": \"string\"\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 4544.087400097556,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 2173.2562321541905,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": \"string\"\n },\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": 6231.408027255953\n },\n \"key_1\": {\n \"type\": \"float\",\n \"value\": false\n },\n \"key_2\": {\n \"type\": \"integer\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"string\",\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n }\n }\n ],\n \"tax_items\": [\n {\n \"type\": \"string\",\n \"id\": \"ca238420-4f24-f74f-d0d3-fe0125066696\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 3017.3432423235467,\n \"amount\": 6069\n },\n {\n \"type\": \"string\",\n \"id\": \"638acf01-9f1c-a86f-b467-52b13524795a\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 2470.197233995308,\n \"amount\": 6195\n }\n ],\n \"custom_discounts\": [\n {\n \"type\": \"string\",\n \"id\": \"e33ed5e4-3bc4-5884-b546-1132893056d2\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 8122.735718157954,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"fc4e43ea-be2c-322b-4dd0-ccccca8dd49d\",\n \"type\": \"cart_item\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"4eade358-2e2e-2eb8-b419-fc86305d37d1\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 7085.643168088125,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"0d47bf76-a999-e1fb-78fd-97e333ae9ef5\",\n \"type\": \"cart_item\"\n }\n }\n }\n }\n ],\n \"promotions\": [\n {\n \"type\": \"string\",\n \"id\": \"2420ab2b-ed39-9c6a-9f10-215c72e69b1e\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"2011-04-09T15:28:37.828Z\",\n \"end\": \"1963-03-30T21:09:24.063Z\"\n },\n {\n \"type\": \"string\",\n \"id\": \"ef4014d4-2acb-fd1b-5713-ab077850e97e\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"2018-07-17T00:17:44.721Z\",\n \"end\": \"1985-03-30T05:04:26.079Z\"\n }\n ]\n },\n \"errors\": [\n {\n \"status\": 1294,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"3D8ZnuH@ZTnltIcTKPsIeaOTXnqmNBsNegOfEcESY.rug\",\n \"component_product_id\": \"d596f5b5-b243-b5fd-7767-23540042214a\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 2452,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"e1f9EBhCYbW717o@GnmeZYHyRWMnqEyGSOoN.ene\",\n \"component_product_id\": \"aed82fd7-0a65-4820-0d77-31dadf4647e1\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f23de232-3040-4058-9bd1-990aaea62bbd", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-delimited string of entities to include (items, tax_items, custom_discounts, promotions).", "type": "text/plain" }, "key": "include", "value": "items" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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 \"errors\": [\n {\n \"detail\": \"Order not found\",\n \"status\": \"404\",\n \"title\": \"Not Found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29d72cd8-2ae8-4526-88af-f45ae0bf8bda", "name": "Update an Order", "request": { "name": "Update an Order", "description": { "content": "You can only update custom data, `shipping`, `shipping_address`, and status of orders. All other settings in the order object are immutable.\n\n This endpoint allows you to:\n\n- **Update an order number and external reference**: You can update an existing order that does not have an `order_number` and `external_ref`, modify the `order_number` and `external_ref` values, or remove them by passing an empty value in the `order_number` and `external_ref` fields.\n- **Cancel an order**: You can cancel an order only if it has not been fulfilled.\n- **Fulfill an order**: You can fulfill a paid order only.\n\n:::caution\n\nYou can update `shipping`, `shipping_address`, and status of an order only if the order is not fulfilled. You can use the refund API to refund an order only if the payment status is `paid`. Canceling an order does not automatically refund a payment. You must refund the orders manually.\n\n:::\n\n:::note\n\n- This request is only accessible to client credentials token users with Seller Admin role.\n- Non client credentials token users cannot access this endpoint. See [Permissions](/docs/authentication/tokens/permissions).\n- The `order_number` will appear as the invoice number in Authorize.net transactions.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The unique identifier of the order.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order\",\n \"status\": \"cancelled\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c17c07a2-fca3-4baa-85a0-da03010884b3", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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 \"data\": {\n \"type\": \"order\",\n \"status\": \"cancelled\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"order_number\": \"string\",\n \"external_ref\": \"string\",\n \"id\": \"d323feba-cf89-664b-750e-5c44be4e8edd\",\n \"status\": \"incomplete\",\n \"payment\": \"partially_authorized\",\n \"shipping\": \"fulfilled\",\n \"anonymized\": false,\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": 372.523300825911\n }\n },\n \"links\": {},\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"fully_paid_at\": \"string\"\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 3464.8629959143527,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 367.98239184148593,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 1232.1274888624,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 6141.193879104563,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 1270.895924320834,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 8943.710159647117,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 8915.810761731836,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 5609.7618722005445,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"is_manual\": false\n },\n \"billing_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\"\n },\n \"contact\": {\n \"email\": \"string\",\n \"name\": \"string\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"mGHb3G6Wl@qamghxFylSZNotUSqY.ruja\",\n \"id\": \"aabedb25-a113-0e6a-a482-a148958809bf\"\n },\n \"shipping_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"relationships\": {\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"344ee6b7-d95a-e715-f0db-a22b7fd61e82\"\n },\n {\n \"type\": \"string\",\n \"id\": \"ab10e21e-cefc-5451-d135-21ba5472b35b\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"9250f981-fb69-25ac-f125-ba1a8d01b0be\"\n },\n {\n \"type\": \"string\",\n \"id\": \"41a9cfab-68b5-d653-5b61-0a56559a6e18\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"7623a0a6-8262-53f2-d668-71062f4f5316\"\n },\n {\n \"type\": \"string\",\n \"id\": \"08313209-73cf-9f72-6e2c-59259fa5b832\"\n }\n ]\n },\n \"customer\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"af663ae1-0d6b-db5b-7ac0-c513c130c42e\"\n }\n },\n \"account\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"dd95f042-eb9b-88ae-61d5-5515c10f4d32\"\n }\n },\n \"account_member\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"2c4c6b7e-0245-eccb-37aa-5aec7e0dac38\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"e0a869ac-ffc4-0dff-8355-9b56e8b74cf4\"\n }\n }\n }\n },\n \"included\": {\n \"items\": [\n {\n \"type\": \"string\",\n \"id\": \"3200a925-1525-6f35-a1ec-f278c9163801\",\n \"quantity\": 8909.363975818273,\n \"product_id\": \"c757785c-48bd-8a59-d1ab-15d3e74e62e2\",\n \"subscription_offering_id\": \"1e1b19a3-ce45-ceae-7865-b64b52415d45\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"location\": \"string\",\n \"unit_price\": {\n \"amount\": 5398.222804432693,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 3160.7786264801407,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 7723.893911593948,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"code\": \"string\",\n \"id\": \"b1743990-9d4f-3d50-655f-fab848ed73ed\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 5452\n },\n {\n \"amount\": {\n \"amount\": 4584.871041996142,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"code\": \"string\",\n \"id\": \"ba59cda8-2380-9080-68b0-f8ea2c38f6d2\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 9304\n }\n ],\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 4401.870186780785,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4383.530125713446,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 7695.775225820343,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 721.9307559551091,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 7664.028862419376,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6158.174407411485,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 4797.1997190235215,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 3429.3500765661265,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 588.9560598956845,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 8559.919948924537,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 3639.6162694267,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 3674.390162428187,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 9812.818248358233,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_2\": {\n \"amount\": 4468.401819186465,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_3\": {\n \"amount\": 9261.202622939694,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 6900.666465076098,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4375.8283106430445,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"cart_item\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"81260321-2b87-f0d2-9bc2-2bb6c47c58d4\"\n }\n },\n \"taxes\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"catalog_id\": \"string\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 5509.714120653497\n },\n \"key_1\": {\n \"key_0\": 4082.9502145839515\n },\n \"key_2\": {\n \"key_0\": 254.9414521778881,\n \"key_1\": 2505.0406434319216\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 8138.5648564450585\n },\n \"meta\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": 7375\n },\n \"price\": {\n \"key_0\": 1485.178044525559,\n \"key_1\": false\n },\n \"relationships\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 4554,\n \"key_1\": true,\n \"key_2\": 5902.734773436655\n },\n \"meta\": {\n \"key_0\": 842.7616813869432,\n \"key_1\": \"string\"\n },\n \"price\": {\n \"key_0\": false\n },\n \"relationships\": {\n \"key_0\": false\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 2218.6773557181705,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 9518.477544462707,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": \"string\"\n },\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"integer\",\n \"value\": 8758.399140270674\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"string\",\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"bf2a8333-00c4-af29-0b66-1fd333267cf4\",\n \"quantity\": 5772.3410478429105,\n \"product_id\": \"c4fff3ab-dbb9-4121-14cf-2b7f7a3438e7\",\n \"subscription_offering_id\": \"73720617-f008-4757-69cf-d0071beff8e9\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"location\": \"string\",\n \"unit_price\": {\n \"amount\": 2287.1295568312157,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 959.3302193705177,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 6443.6568061889975,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"code\": \"string\",\n \"id\": \"83b5470a-f362-054d-81de-61a3af86dc62\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 9281\n },\n {\n \"amount\": {\n \"amount\": 8179.368039872925,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"code\": \"string\",\n \"id\": \"94c05c1e-9e20-3b04-5fc7-ec29cfc29375\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 3829\n }\n ],\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 1240.785478584112,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 1303.24736875977,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 1478.3483563332634,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9333.654371245575,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 6724.54517149389,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4637.4020830106265,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 7459.364194939868,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6370.629765223699,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 2177.868005315262,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9729.961357080449,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 1329.0871601378828,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 3878.599332265682,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 7716.373585352827,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_2\": {\n \"amount\": 8076.098308055431,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 8346.884182218122,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 9372.557054015491,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 7708.372468726739,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 5343.028673516687,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 5313.930381539245,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"cart_item\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"bf395c80-1662-dbc2-2024-69b2fe972eb5\"\n }\n },\n \"taxes\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"catalog_id\": \"string\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 6998.1419242093225,\n \"key_1\": 8939.646245425154\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 3354,\n \"key_1\": 6314,\n \"key_2\": 8537\n },\n \"meta\": {\n \"key_0\": 1352.5710172064298,\n \"key_1\": 7181.341598620241\n },\n \"price\": {\n \"key_0\": false,\n \"key_1\": 1712.7866656570022,\n \"key_2\": 7490\n },\n \"relationships\": {\n \"key_0\": \"string\",\n \"key_1\": 4563.852831809738,\n \"key_2\": 9456.32119817703\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": false,\n \"key_1\": true\n },\n \"meta\": {\n \"key_0\": 779.1403012262222\n },\n \"price\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 28.13164969440063\n },\n \"relationships\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 536.9649963041168,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 6871.369035567512,\n \"type\": \"string\"\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 4544.087400097556,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 2173.2562321541905,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": \"string\"\n },\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": 6231.408027255953\n },\n \"key_1\": {\n \"type\": \"float\",\n \"value\": false\n },\n \"key_2\": {\n \"type\": \"integer\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"string\",\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n }\n }\n ],\n \"tax_items\": [\n {\n \"type\": \"string\",\n \"id\": \"ca238420-4f24-f74f-d0d3-fe0125066696\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 3017.3432423235467,\n \"amount\": 6069\n },\n {\n \"type\": \"string\",\n \"id\": \"638acf01-9f1c-a86f-b467-52b13524795a\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 2470.197233995308,\n \"amount\": 6195\n }\n ],\n \"custom_discounts\": [\n {\n \"type\": \"string\",\n \"id\": \"e33ed5e4-3bc4-5884-b546-1132893056d2\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 8122.735718157954,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"fc4e43ea-be2c-322b-4dd0-ccccca8dd49d\",\n \"type\": \"cart_item\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"4eade358-2e2e-2eb8-b419-fc86305d37d1\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 7085.643168088125,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"0d47bf76-a999-e1fb-78fd-97e333ae9ef5\",\n \"type\": \"cart_item\"\n }\n }\n }\n }\n ],\n \"promotions\": [\n {\n \"type\": \"string\",\n \"id\": \"2420ab2b-ed39-9c6a-9f10-215c72e69b1e\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"2011-04-09T15:28:37.828Z\",\n \"end\": \"1963-03-30T21:09:24.063Z\"\n },\n {\n \"type\": \"string\",\n \"id\": \"ef4014d4-2acb-fd1b-5713-ab077850e97e\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"2018-07-17T00:17:44.721Z\",\n \"end\": \"1985-03-30T05:04:26.079Z\"\n }\n ]\n },\n \"errors\": [\n {\n \"status\": 1294,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"3D8ZnuH@ZTnltIcTKPsIeaOTXnqmNBsNegOfEcESY.rug\",\n \"component_product_id\": \"d596f5b5-b243-b5fd-7767-23540042214a\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 2452,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"e1f9EBhCYbW717o@GnmeZYHyRWMnqEyGSOoN.ene\",\n \"component_product_id\": \"aed82fd7-0a65-4820-0d77-31dadf4647e1\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a6aadf1-56e1-4b4b-a6e7-312829844074", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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 \"data\": {\n \"type\": \"order\",\n \"status\": \"cancelled\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Request could not be processed\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a059e558-8fc1-4a38-bbbc-2fddb73bd590", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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 \"data\": {\n \"type\": \"order\",\n \"status\": \"cancelled\"\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 \"errors\": [\n {\n \"detail\": \"Order cannot be updated in its current state\",\n \"status\": \"422\",\n \"title\": \"Unprocessable Entity\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83fbbb10-cfe2-45e1-b7d9-e0c06245627f", "name": "Get Order Items", "request": { "name": "Get Order Items", "description": { "content": "Use this endpoint to retrieve order items.\n\n### Includes\n\nYou can include related resources with the order items response by using the `include` query parameter.\n\n| Name | Required | Type | Description |\n|:----------|:---------|:---------|:------------|\n| `include` | Optional | `string` | Comma-delimited string of entities that can be included. The included options are `tax_items`, `custom_discounts`, or `promotions`. |", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-delimited string of entities to include (tax_items, custom_discounts, promotions).", "type": "text/plain" }, "key": "include", "value": "tax_items" } ], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The ID of the order.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "49d50cbe-55cc-488c-b689-4f44f9246b05", "name": "200", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-delimited string of entities to include (tax_items, custom_discounts, promotions).", "type": "text/plain" }, "key": "include", "value": "tax_items" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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 \"type\": \"string\",\n \"id\": \"ee00f5fe-544d-42bc-acc3-81ea3a96b61f\",\n \"quantity\": 3464.906545404076,\n \"product_id\": \"33ee8d24-7531-82e1-ae5a-68a8e8fbf408\",\n \"subscription_offering_id\": \"f5f054a6-b493-0c18-103d-94b03cd9e473\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"location\": \"string\",\n \"unit_price\": {\n \"amount\": 5559.060715629893,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"value\": {\n \"amount\": 3155.7078772458613,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 9313.4976609051,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"code\": \"string\",\n \"id\": \"8b7c0e86-70ca-c6b1-022b-9363f9d58400\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 1646\n },\n {\n \"amount\": {\n \"amount\": 2524.9648322209796,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"code\": \"string\",\n \"id\": \"87fe107a-134d-382d-c809-080559ebd18a\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 1156\n }\n ],\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 7649.372786125814,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 2867.8913011828345,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 70.21120955897908,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9430.043151712787,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 6628.663984702465,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4138.338610864589,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 3538.177279721466,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7695.591376700912,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 4369.956101279595,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4299.459583555034,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 6256.684773710183,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 2776.3199449398467,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 155.6596830805912,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 8785.59054639018,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 2193.271131861563,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 159.7755350837038,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_2\": {\n \"amount\": 2856.543828950313,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_3\": {\n \"amount\": 5119.249866979838,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_2\": {\n \"amount\": 8034.382819969949,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 5313.870154111431,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 2915.560442554397,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 425.09471158806764,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 2879.1901461032676,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"cart_item\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"ffe5c87a-20c2-caba-829c-5b1ad51430ee\"\n }\n },\n \"taxes\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"catalog_id\": \"string\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 6494.519623841397,\n \"key_1\": 2579.6638477987653,\n \"key_2\": 6674.728087185355,\n \"key_3\": 9255.77386759342\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 7581.036665937937,\n \"key_1\": 2733,\n \"key_2\": 8275.870448112097\n },\n \"meta\": {\n \"key_0\": 9864,\n \"key_1\": 6948,\n \"key_2\": 510.07695406551255\n },\n \"price\": {\n \"key_0\": \"string\"\n },\n \"relationships\": {\n \"key_0\": false\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": \"string\"\n },\n \"meta\": {\n \"key_0\": false\n },\n \"price\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\"\n },\n \"relationships\": {\n \"key_0\": \"string\",\n \"key_1\": true\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 5309.692053791888,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 2838.1214242303067,\n \"type\": \"string\"\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 2946.122374425073,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 1781.5056476844604,\n \"type\": \"string\"\n }\n ]\n },\n \"key_2\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 698.8841458621508,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 2645.641785734414,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": 4446.298663874258,\n \"key_1\": 6289,\n \"key_2\": 6390\n },\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"boolean\",\n \"value\": \"string\"\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": \"string\"\n },\n \"key_2\": {\n \"type\": \"integer\",\n \"value\": \"string\"\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"string\",\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"17e78ab0-89a4-7404-f448-2e560c773767\",\n \"quantity\": 8557.059300262192,\n \"product_id\": \"dfd6475e-af25-9587-2d5e-d97da1bd0182\",\n \"subscription_offering_id\": \"4361ff34-e24a-221e-6d0e-60358847b117\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"location\": \"string\",\n \"unit_price\": {\n \"amount\": 2268.8536161473194,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"value\": {\n \"amount\": 6859.253825850502,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 2549.8665315466806,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"code\": \"string\",\n \"id\": \"751187fe-e1cb-99be-ff61-224833d9cc19\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 7884\n },\n {\n \"amount\": {\n \"amount\": 3016.3972788134943,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"code\": \"string\",\n \"id\": \"37246941-f2c0-74ef-609e-b7b53e135526\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 1635\n }\n ],\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 4125.373671963395,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 1109.8546553245249,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 8312.827222023594,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 64.3126852762399,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 5831.571840690708,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 1211.1005603581316,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 9367.702414291767,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4363.108835608696,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 8589.712015043382,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 5186.721620763133,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 4855.092874461593,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 5934.125766914149,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 19.66965176755986,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 9801.782852351707,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 6759.590979531187,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 2707.7016455071343,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 8735.666792191254,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 8433.32257331464,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"cart_item\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"c342248d-fd49-fb7f-1558-3a594fc4997f\"\n }\n },\n \"taxes\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"catalog_id\": \"string\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 6438.543268488886,\n \"key_1\": 7386.463676671356,\n \"key_2\": 1031.2997662681812\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 8932\n },\n \"meta\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"price\": {\n \"key_0\": 8897,\n \"key_1\": 2545.712443876855,\n \"key_2\": true,\n \"key_3\": 8466,\n \"key_4\": \"string\"\n },\n \"relationships\": {\n \"key_0\": 7267.052155373104\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 7898.484318544716\n },\n \"meta\": {\n \"key_0\": false\n },\n \"price\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"relationships\": {\n \"key_0\": true\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 9163.902258530816,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 8869.041273871442,\n \"type\": \"string\"\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 7766.81744081136,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 7971.797255217818,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": true,\n \"key_1\": 1790.8099313550906,\n \"key_2\": 4723,\n \"key_3\": \"string\",\n \"key_4\": \"string\"\n },\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"float\",\n \"value\": true\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"string\",\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n }\n }\n ],\n \"included\": {\n \"tax_items\": [\n {\n \"type\": \"string\",\n \"id\": \"22dd3d27-1688-1e72-9d63-3849fbffe831\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 4524.869484084475,\n \"amount\": 9931\n },\n {\n \"type\": \"string\",\n \"id\": \"fa4fccbc-90c2-fc56-11d5-eb4ab08b9a1b\",\n \"jurisdiction\": \"string\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"rate\": 8669.054417222102,\n \"amount\": 8646\n }\n ],\n \"custom_discounts\": [\n {\n \"type\": \"string\",\n \"id\": \"042bc5bf-281f-172e-f537-f69a48319df0\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 171.07621150043605,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"73306f82-5ccc-cc11-c967-fc032b15ea6c\",\n \"type\": \"custom_item\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"70476bb4-50f1-5ba6-e97e-5ad032fb662a\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 9854.329422873745,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"50c12046-61b5-60af-2fa9-902c7235ec05\",\n \"type\": \"cart_item\"\n }\n }\n }\n }\n ],\n \"promotions\": [\n {\n \"type\": \"string\",\n \"id\": \"2d431c2c-fe89-06f4-4082-784214dc5a18\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": true,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1957-02-26T23:25:37.390Z\",\n \"end\": \"1996-07-16T13:54:01.141Z\"\n },\n {\n \"type\": \"string\",\n \"id\": \"df4b4998-5245-ec3c-ca47-0bc5e10a3f28\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1974-01-09T09:28:38.446Z\",\n \"end\": \"1983-05-24T05:36:29.224Z\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b50ffe5-dd1f-4d93-bbc3-354598e4a0cd", "name": "Anonymize Orders", "request": { "name": "Anonymize Orders", "description": { "content": "You can anonymize an order when it is fulfilled, canceled, or fully refunded.\n\nWhen anonymization is successful, Personal Identifiable Information such as customer details, `shipping_address`, and `billing_address` are replaced with *.\n", "type": "text/plain" }, "url": { "path": [ "v2", "orders", "anonymize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"order_ids\": [\n \"{{orderID}}\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8d098f8f-9e3c-4627-ae39-03c1c0c28059", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "orders", "anonymize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"order_ids\": [\n \"{{orderID}}\"\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 \"type\": \"string\",\n \"order_number\": \"string\",\n \"external_ref\": \"string\",\n \"id\": \"1c5e86ee-3c67-cb76-b4d6-cf8a354a6fed\",\n \"status\": \"complete\",\n \"payment\": \"partially_paid\",\n \"shipping\": \"unfulfilled\",\n \"anonymized\": true,\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n \"links\": {},\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"fully_paid_at\": \"string\"\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8124.321601618445,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 3280.886469387949,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 6347.956620405841,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 6658.807171347052,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 1446.3190590176177,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 6078.9211197355435,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 7585.420820222377,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 1940.170512448207,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"is_manual\": false\n },\n \"billing_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\"\n },\n \"contact\": {\n \"email\": \"string\",\n \"name\": \"string\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"Z3bP@FuDiWRkYrxQ.ugr\",\n \"id\": \"e882c872-b9ec-30d0-55d7-284437e5170d\"\n },\n \"shipping_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"relationships\": {\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"0ebe5833-d999-f8dc-b602-d5300f37f540\"\n },\n {\n \"type\": \"string\",\n \"id\": \"4343f36e-538b-b066-b671-c84c09b888a7\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"adbca1b7-97ff-13d7-f835-9b8d9accc21e\"\n },\n {\n \"type\": \"string\",\n \"id\": \"9bc3314a-7bc2-b92a-570e-b5fd2a19f31e\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"7eeb847e-867d-cb08-c273-52c776f6489e\"\n },\n {\n \"type\": \"string\",\n \"id\": \"c7b41756-bd4b-44ae-f068-721688de6441\"\n }\n ]\n },\n \"customer\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"d407fd99-ad5c-28c2-5e44-58f614ae3a8f\"\n }\n },\n \"account\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"05182dd0-000e-ce80-5243-b24a32a4bf33\"\n }\n },\n \"account_member\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"ce6f524d-1857-843a-0a21-eb8eb329ea50\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"a2d960a9-d450-9ab5-98b3-8be87a05c6ba\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"order_number\": \"string\",\n \"external_ref\": \"string\",\n \"id\": \"6251a4e8-7428-7a36-9b2a-4b55e597bb01\",\n \"status\": \"processing\",\n \"payment\": \"partially_paid\",\n \"shipping\": \"unfulfilled\",\n \"anonymized\": false,\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": true\n },\n \"key_1\": {\n \"type\": \"float\",\n \"value\": false\n },\n \"key_2\": {\n \"type\": \"float\",\n \"value\": \"string\"\n }\n },\n \"links\": {},\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"fully_paid_at\": \"string\"\n },\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 5277.020748670238,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 9283.360130491754,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 9336.460294715745,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 5946.123198791029,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 4243.788281460678,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 7208.1668179256185,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 2820.7796466523205,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 5282.598544171777,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"is_manual\": false\n },\n \"billing_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\"\n },\n \"contact\": {\n \"email\": \"string\",\n \"name\": \"string\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"GBrDV@wOwtRwqWzJUBOOhJUyyXYfZHg.eewu\",\n \"id\": \"66955faf-3340-fb68-63e0-cab47118cab0\"\n },\n \"shipping_address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"relationships\": {\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"03cde0dd-8930-369c-1183-025f63c6f85b\"\n },\n {\n \"type\": \"string\",\n \"id\": \"f61112cf-1da3-805d-0dfe-0d7d85672c46\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"f8f988ed-e822-0a51-83ef-1add1dce655b\"\n },\n {\n \"type\": \"string\",\n \"id\": \"2e9ed284-ff3f-0572-ee7d-b3d73ec6cb66\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"f053a1fc-969c-2cd6-ea0d-87c1a6cc925c\"\n },\n {\n \"type\": \"string\",\n \"id\": \"b8bef86b-a373-44b4-7a79-22de7f66f1c3\"\n }\n ]\n },\n \"customer\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"410f036c-27c6-79fe-830b-f97af380c5c2\"\n }\n },\n \"account\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"090fec35-feab-602c-9fd3-f389e9e30bed\"\n }\n },\n \"account_member\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"e8214952-42da-9ad9-f129-59881d71e64a\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"a358c3e6-6f86-bb8c-9c9a-35a57a131c46\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6ea4a4d-3ec0-4bef-a794-1081c9bbcf2e", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "orders", "anonymize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"order_ids\": [\n \"{{orderID}}\"\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 \"errors\": [\n {\n \"detail\": \"Order has status: order:incomplete, payment:unpaid, shipping:unfulfilled; only fulfilled or refunded or cancelled orders may be anonymized\",\n \"status\": 422,\n \"title\": \"Could not anonymize orders\",\n \"meta\": {\n \"order_id\": \"496c29a1-6e7a-4ab6-a4e7-d1ec9a08b85e\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b52abb72-bc51-4f2a-a721-d7938b04305b", "name": "Confirm Order", "request": { "name": "Confirm Order", "description": { "content": "Use this endpoint to confirm an order. Confirming an order finalizes it and makes it ready for processing.\n", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The unique identifier of the order to confirm.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "ed8acdf1-a238-4efe-9caa-82db30eb709f", "name": "Order confirmed successfully", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order to confirm.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "header": [ { "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": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"37d82752-ff41-796c-ee3c-3cb313a462c2\",\n \"reference\": \"string\",\n \"name\": \"string\",\n \"custom_reference\": \"string\",\n \"gateway\": \"stripe_payment_intents\",\n \"amount\": 6611.901005283578,\n \"refunded_amount\": 6164.618584994863,\n \"currency\": \"string\",\n \"transaction_type\": \"authorize\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"payment_details\": {\n \"detailed_status\": \"string\"\n },\n \"failure_details\": {\n \"code\": \"string\",\n \"reason\": \"string\"\n },\n \"payment_intent\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": true\n },\n \"capture_mechanism\": \"automatic\",\n \"refund_mechanism\": \"automatic\",\n \"client_parameters\": {\n \"redirect_url\": \"string\",\n \"secret\": \"string\",\n \"token\": \"string\"\n },\n \"next_actions\": [\n \"string\",\n \"string\"\n ],\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"b4c10f69-8f2a-eb16-21af-7a11ec10a31b\"\n }\n }\n },\n \"meta\": {\n \"display_price\": {\n \"amount\": 2825.9416938070526,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"display_refunded_amount\": {\n \"total\": {\n \"amount\": 6946.64638432702,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "510f7365-cafa-41cd-aeae-165b98c1d6b8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order to confirm.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "header": [ { "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": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Request could not be processed\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e2b560f-90f6-4584-a607-20c6b65aca93", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order to confirm.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "header": [ { "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": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Order not found\",\n \"status\": \"404\",\n \"title\": \"Not Found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "186ae729-01f7-4c4c-8a84-19194f73d76d", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order to confirm.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "header": [ { "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": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Order cannot be confirmed in its current state\",\n \"status\": \"422\",\n \"title\": \"Unprocessable Entity\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Payments", "description": "When you [checkout](/docs/api/carts/checkout) a [cart](/docs/api/carts/cart-management), an unpaid [order](/docs/api/carts/orders) is returned. You can process the payment for the order though a payment gateway.\n\n:::note\n\n- You need to configure and enable a payment gateway before you can accept payments for orders.\n- Configure your store to use [Manual Gateway](/docs/api/payments/update-manual-gateway) to process payments if the order total is zero or the payment is through non-supported payment providers.\n- There are a number of actions that happen to your inventory when checking out and paying for an order. For more information, see [Inventory](/docs/api/pxm/inventory/inventories-introduction).\n- We recommend to wait until the payment confirmation process is fully completed before proceeding with any additional updates to the order. Making simultaneous updates to the same entity immediately after payment confirmation can lead to a race condition. To learn more information on handling parallel calls to API objects, see [Parallel Calls to API Objects](/guides/Getting-Started/api-contract#parallel-calls-to-api-objects).\n\n:::\n\n### Payment Methods\n\nDepending on the chosen gateway, you may or may not have access to capture funds immediately or authorize for later payment.\n\nTo make a partial payment in Postman through any payment gateway, specify the desired payment amount in the amount field within the request body. To learn about Split Payments, see the [Split Payments](/docs/api/payments/payment-gateways-introduction#split-payments) section.\n\n#### Purchase\n\nThe simplest method is purchase. The gateway attempts to charge the customer immediately, and the result of the attempt is returned.\n\nYou can partially pay funds using purchase method. The gateway attempts to charge the customer immediately, and the payment status for an order shows `partially_paid`.\n\nWhen you Get an order, you can see the following fields in the `meta` object:\n\n- `balance_owing`: Specifies the outstanding funds required to complete an order. It considers all complete or pending transactions, including authorized, paid, and captured transactions. (`balance_owing` = order total - `authorized` amount - `paid` amount).\n- `paid`: Specifies the total amount of purchased or captured transactions.\n- `authorized`: Specifies the total amount of completed or pending authorized transactions for an order.\n\n#### Authorize\n\nYou can `authorize` a payment so funds can later be captured when an item is dispatched or restocked.\n\nYou can partially pay for an order using `authorize` payment method so that the order is `partially_authorized`. The transaction must be complete for the order status to be `partially_authorized`.\n\nFor more information about order and payment statuses for split payments, see [Split Payments](/docs/api/payments/payment-gateways-introduction#split-payments).\n\n#### Capture\n\nAfter authorizing a transaction, you have to capture the authorized funds.\n\n:::note\n\nWe recommend capturing payments several hours to days after the authorization to mitigate risks of fraud and chargebacks. When you sell digital goods that are delivered immediately, we recommend using a single purchase call instead of separate authorize and capture calls.\n\n:::\n\nAfter the payment is `partially_authorized`, you must `capture` the authorized transaction later. Once you capture the authorized transactions, the order payment status will change to `partially_paid`.\n\n#### Refunds\n\nYou can use either the Refund through Composable Commerce or use the Mark as Refunded capability, or a combination of both capabilities.\n\nFor more information about refund for split payments, see [Refund a Payment](/docs/api/carts/refund-a-transaction).\n\n#### Refund through Composable Commerce\n\nYou can start a full or partial refund to a supported payment provider directly from Commerce Manager or the API. When you start the refund process, the refund request is sent to the payment gateway. You no longer have to log on to your payment gateway's console to process the refund.\n\nWhen you process a refund, use the refund endpoint to pass the refund amount. If you don't pass an amount, the refund is processed as Mark as refunded. For more information, see the Mark as Refunded section.\n\nEach time a partial refund is triggered, the transaction.updated event is generated and updated with refunded.amount. The `order.updated` event is also triggered. The `order.refunded` event generates when the full amount is refunded.\n\n\n#### Mark as Refunded\n\nYou can use your payment gateway's console to process a refund. Process the refund first in the payment gateway and then use the **Mark as Refunded** capability in Composable Commerce to complete the process.\n\nWhen an order is **Marked as refunded**, the payment status `order.payment.status` is set to `refunded`. In this case, the `order.updated`, `transaction.updated` and `order.refunded` events are generated.\n", "item": [ { "id": "0ac2dcec-c3f5-4e82-aa3a-59fb9266b64d", "name": "Create Stripe Payment Intent for a Cart", "request": { "name": "Create Stripe Payment Intent for a Cart", "description": { "content": "The Cart Payment Intent feature enables the creation of a Stripe Payment Intent specifically tied to a shopping cart and its subsequent order. This allows Payment Intent users to track payment details from the cart stage and seamlessly maintain consistency in payment information throughout the order stage. Using these features, you can create Payment Intents for their carts, update Payment Intents with final cart details, and synchronize Payment Intents from Stripe to Commerce.\n\n:::note\n\n- Typically, in Commerce, inventory is allocated at the time of payment initiation after an order is created. However, in the case of Cart Payment Intent, information about the payment is received only upon synchronizing the order from Stripe to Commerce. This may happen after the payment is completed. Therefore, there might be a delay between the payment made and allocation, increasing the chance of paying for items that are not in stock.\n- There are certain fields you can choose to set up when [creating a payment intent](https://stripe.com/docs/api/payment_intents/create). However, if you decide to update a payment intent, the available options may not be the same as those allowed while creating a payment intent. See [updating a payment intent](https://stripe.com/docs/api/payment_intents/update).\n\n:::\n\nThe following steps outline the workflow associated with the Payment Intent:\n\n1. [Add items to cart](/docs/api/carts/manage-carts#add-custom-item-to-cart).\n1. [Create a Payment Intent for the cart](/docs/api/carts/create-cart-payment-intent). The Payment Intent is created in Stripe, reflecting the cart and transaction details, including currency, amounts, payment type, and any optional Stripe details. The Payment Intent ID is generated and linked to the cart.\n1. [Update a Payment Intent](/docs/carts-orders/update-cart-payment-intent). This step is optional but becomes necessary when there are changes in the cart details at the time of payment. It ensures the Payment Intent accurately reflects the current cart details when processing the payments on the front end.\n1. [Checkout the cart](/docs/api/carts/checkout). An unpaid order is created, and the Payment Intent ID is linked to the order.\n1. [Confirm the order](/docs/carts-orders/confirm-an-order). This is important because after checkout, it is essential to confirm the Payment Intent and synchronize it with Commerce. This results in a corresponding transaction and change in order statuses in Commerce. Additionally, the Payment Intent ID is removed from the order once it is linked via the transaction.\n\n### Best Practices\n\nWe recommend you follow these practices to maintain consistency and accuracy when using Cart Payment Intent.\n\n- After checkout, we recommend clearing the shopping cart. You can achieve this using a [Delete a cart](/docs/api/carts/delete-a-cart) endpoint or [Update a cart](/docs/api/carts/update-a-cart) to remove the Payment Intent ID. This helps to avoid potential issues where subsequent checkouts for the same cart might unintentionally use the previous Stripe Payment Intent ID.\n- If it is not reasonable to clear the cart immediately after checkout due to several subsequent, duplicate checkouts to the same cart, ensure that you only synchronize the Payment Intent when finalizing the order. Each order confirmation is unaware of the others, and syncing Payment Intent IDs for each confirmation can lead to duplicate transactions in Commerce. In other words, if you synchronize Payment Intents for earlier versions of a repeated checkout, you'll end up with multiple orders from the same cart, each having transactions linked to the same Payment Intent.\n- To pay the entire amount at once, use the [Update Cart Payment Intent](/docs/carts-orders/update-cart-payment-intent) endpoint to update the Stripe Payment Intent with the final cart details when preparing to take the payment. Doing so, ensures that the Payment Intent accurately reflects the current cart details when processing payments on the front end. We do not recommend calling the [Update Cart Payment Intent](/docs/carts-orders/update-cart-payment-intent) for each individual change in the cart, as this can lead to more requests and may slow down the front-end performance.\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The universally unique identifier of the cart for which you want to create a payment intent.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"gateway\": \"elastic_path_payments_stripe\",\n \"method\": \"purchase\",\n \"options\": {\n \"automatic_payment_methods\": {\n \"enabled\": true\n },\n \"receipt_email\": \"john@example.com\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a6e5841a-bba0-444b-8781-e4522677f357", "name": "Payment Intent created successfully.", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The universally unique identifier of the cart for which you want to create a payment intent.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"gateway\": \"elastic_path_payments_stripe\",\n \"method\": \"purchase\",\n \"options\": {\n \"automatic_payment_methods\": {\n \"enabled\": true\n },\n \"receipt_email\": \"john@example.com\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"contact\": {\n \"email\": \"xeDXFzKwAyR@NFU.edl\"\n },\n \"discount_settings\": {\n \"custom_discounts_enabled\": true,\n \"use_rule_promotions\": false\n },\n \"inventory_settings\": {\n \"defer_inventory_check\": false\n },\n \"item_settings\": {\n \"separate_items_by_location\": true\n },\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": 5799.183081697556\n },\n \"key_1\": {\n \"type\": \"integer\",\n \"value\": true\n },\n \"key_2\": {\n \"type\": \"float\",\n \"value\": 6605.193068470192\n }\n },\n \"snapshot_date\": \"1984-05-08T11:16:27.262Z\",\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8335.403926465655,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 4521.2827265191445,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 1097.22823427588,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 5353.789609953707,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 9179.612124743386,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 1310.4079749712016,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 5450.502653055869,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"expires_at\": \"string\"\n },\n \"promotion_suggestions\": [\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 1268,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 5762,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n },\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 6425,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 6345,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n }\n ]\n },\n \"relationships\": {\n \"customers\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"00c38ee6-a1ad-f92e-c207-466e418faf04\"\n },\n {\n \"type\": \"string\",\n \"id\": \"b71ccf30-6c9d-1dd6-7702-02110fbde8ca\"\n }\n ]\n },\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"d9e07c05-8b8f-8b73-0bf3-f387e5a54ec6\"\n },\n {\n \"type\": \"string\",\n \"id\": \"6919c16a-323d-3efd-436f-739e234d3ebb\"\n }\n ]\n },\n \"accounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"e6494c38-1c85-1612-aa4f-84d6640d48df\"\n },\n {\n \"type\": \"string\",\n \"id\": \"1e134a7e-210e-9b2d-e2cd-8af245c58ac4\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"ddddd9de-ad63-6bc0-6a93-de7a98057d60\"\n },\n {\n \"type\": \"string\",\n \"id\": \"fccca761-c8e3-88d9-cecf-f0897a954631\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"a3e5dcd5-682e-3ff1-4491-8864173fe9f2\"\n },\n {\n \"type\": \"string\",\n \"id\": \"e0fb42e6-aa73-e142-9201-5b9ae96bcd56\"\n }\n ]\n }\n },\n \"type\": \"string\"\n },\n \"included\": {\n \"custom_discounts\": [\n {\n \"type\": \"string\",\n \"id\": \"5c42e1a9-d3e1-5c87-604c-d2038b9e57d4\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 1177.2432667943278,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"31585381-e220-14a0-dfd2-8fc359b36761\",\n \"type\": \"cart_item\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"1a5e5206-ba1e-90d8-4c62-35c9197aae1a\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 6500.5931659885355,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"1a80d140-0544-6cb0-a5b6-92c2bb463fde\",\n \"type\": \"cart_item\"\n }\n }\n }\n }\n ],\n \"promotions\": [\n {\n \"type\": \"string\",\n \"id\": \"edc03c37-d6b1-4d48-e417-a55441ee68ea\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1964-08-16T03:07:46.846Z\",\n \"end\": \"1961-07-21T03:04:33.803Z\"\n },\n {\n \"type\": \"string\",\n \"id\": \"6a9e94c9-373c-4b08-c235-0b01eadbb578\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": true,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1968-09-23T14:15:29.513Z\",\n \"end\": \"1979-10-14T14:46:20.220Z\"\n }\n ]\n },\n \"meta\": {\n \"payment_intent\": {\n \"key_0\": true,\n \"key_1\": 6015,\n \"key_2\": 3149.423768778801\n }\n },\n \"errors\": [\n {\n \"status\": 9866,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"Pt-CPET-v@vJobjBjFIPEZLoXjoE.ey\",\n \"component_product_id\": \"59f7cde3-4669-4e28-750b-e0a37d3a31e7\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 2437,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"PeE-KXwTfA50@ONyIrEaZmHqVdVkhf.vnp\",\n \"component_product_id\": \"d9548207-f7f4-8a7c-0f51-be17158f2590\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7bd563d-852c-4440-9d2b-9d136639cf29", "name": "Payments", "request": { "name": "Payments", "description": { "content": "Depending on the payment gateway, you may have access to different transaction types such as capturing funds immediately or authorizing them for later. For more information, see [Payments](/docs/api/carts/payments).\n\nThe following types of payment methods are available depending on the payment gateway:\n\n- `purchase`: This is the simplest method. The gateway attempts to charge the customer immediately.\n- `authorize`: This method authorizes a payment so that funds can be captured later, for example, when an item is dispatched or restocked.\n- `purchase_setup`: This method prepares the system for a purchase by verifying payment details without actually charging the customer. For example, a customer adds items to their cart and proceeds to checkout. Before finalizing the purchase, the system runs `purchase_setup` to confirm all payment details, but no funds are transferred until the customer confirms the order.\n- `authorize_setup`: This method prepares the system for an authorization-only transaction. This process holds the necessary funds but does not transfer them, ensuring that the customer has sufficient balance for the transaction. It sets up the conditions for a future capture of the authorized funds. For example, a customer places a pre-order for a product that will ship in two weeks. The merchant uses `authorize_setup` to prepare for the payment authorization. This holds the customer's funds to ensure they can cover the purchase but waits to capture the payment until the product ships. This ensures that payment is secured but not collected prematurely.\n\n:::note\n\nSplit payments can be performed using any methods for any gateway.\n\n- You can partially pay funds using `purchase` method. The gateway attempts to charge the customer immediately, and the payment status for an order will show `partially_paid`\n- You can partially pay for an order using `authorize` method where the order will be marked as `partially_authorized`. The transaction must be completed for the order status to be `partially_authorized`.\n- A `purchase_setup` method allows verification of payment details for partial payments without transferring funds until the customer confirms the full order.\n- An `authorize_setup` method can be used to hold a partial amount of the total funds, ensuring the customer has enough balance for a future capture.\nUntil a payment is made neither `purchase_setup` nor `authorize_setup` affects the payment statuses, and the order remains unpaid. For more information about order and payment statuses for split payments, see [Split payments](/docs/api/payments/payment-gateways-introduction#split-payments).\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The Universally Unique Identifier (UUID) of the order you want to pay for.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"gateway\": \"cyber_source\",\n \"method\": \"purchase\",\n \"payment\": \"string\",\n \"amount\": 6841.663325469096,\n \"options\": {\n \"shopper_reference\": \"string\",\n \"recurring_processing_model\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "da05fcc6-aad3-4a59-bd68-a28418f168df", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The Universally Unique Identifier (UUID) of the order you want to pay for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"gateway\": \"cyber_source\",\n \"method\": \"purchase\",\n \"payment\": \"string\",\n \"amount\": 6841.663325469096,\n \"options\": {\n \"shopper_reference\": \"string\",\n \"recurring_processing_model\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"37d82752-ff41-796c-ee3c-3cb313a462c2\",\n \"reference\": \"string\",\n \"name\": \"string\",\n \"custom_reference\": \"string\",\n \"gateway\": \"stripe_payment_intents\",\n \"amount\": 6611.901005283578,\n \"refunded_amount\": 6164.618584994863,\n \"currency\": \"string\",\n \"transaction_type\": \"authorize\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"payment_details\": {\n \"detailed_status\": \"string\"\n },\n \"failure_details\": {\n \"code\": \"string\",\n \"reason\": \"string\"\n },\n \"payment_intent\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": true\n },\n \"capture_mechanism\": \"automatic\",\n \"refund_mechanism\": \"automatic\",\n \"client_parameters\": {\n \"redirect_url\": \"string\",\n \"secret\": \"string\",\n \"token\": \"string\"\n },\n \"next_actions\": [\n \"string\",\n \"string\"\n ],\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"b4c10f69-8f2a-eb16-21af-7a11ec10a31b\"\n }\n }\n },\n \"meta\": {\n \"display_price\": {\n \"amount\": 2825.9416938070526,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"display_refunded_amount\": {\n \"total\": {\n \"amount\": 6946.64638432702,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "773c8496-12af-43de-88e0-11b9618c5a49", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The Universally Unique Identifier (UUID) of the order you want to pay for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"gateway\": \"cyber_source\",\n \"method\": \"purchase\",\n \"payment\": \"string\",\n \"amount\": 6841.663325469096,\n \"options\": {\n \"shopper_reference\": \"string\",\n \"recurring_processing_model\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Request could not be processed\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8be9c285-695f-48ac-b5bc-b8a891eeeaa1", "name": "Conflict", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The Universally Unique Identifier (UUID) of the order you want to pay for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"gateway\": \"cyber_source\",\n \"method\": \"purchase\",\n \"payment\": \"string\",\n \"amount\": 6841.663325469096,\n \"options\": {\n \"shopper_reference\": \"string\",\n \"recurring_processing_model\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "858bce4e-ca45-4a2c-94f7-842ea1820f9a", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The Universally Unique Identifier (UUID) of the order you want to pay for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"gateway\": \"cyber_source\",\n \"method\": \"purchase\",\n \"payment\": \"string\",\n \"amount\": 6841.663325469096,\n \"options\": {\n \"shopper_reference\": \"string\",\n \"recurring_processing_model\": \"string\"\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 \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3f98a21-4b81-473d-b444-71b4822eb1cd", "name": "Confirm Payment", "request": { "name": "Confirm Payment", "description": { "content": "Confirm Payment serves as a mechanism to synchronize transaction information from the third-party payment provider back to our system. This ensures that Composable Commerce accurately reflects the values from the payment provider.\n\n### Handling 3D Secure Validations for Stripe Payments\n\nFor Stripe Payments requiring 3D Secure validation, the transaction response will include the `client_parameters` object, which provides credentials to support validation of these payment requests on the payment provider's side. We recommend using the Stripe's client libraries to manage these 3D Secure validations. Once the validation succeeds, proceed with a confirmation request to sync the validated transaction into Composable Commerce and continue with the payment process.\n", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The unique identifier of the order.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "transactionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "106b087f-357b-4f05-9a69-90078d1dc2e3", "name": "200", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction.", "type": "text/plain" }, "type": "any", "value": "string", "key": "transactionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"37d82752-ff41-796c-ee3c-3cb313a462c2\",\n \"reference\": \"string\",\n \"name\": \"string\",\n \"custom_reference\": \"string\",\n \"gateway\": \"stripe_payment_intents\",\n \"amount\": 6611.901005283578,\n \"refunded_amount\": 6164.618584994863,\n \"currency\": \"string\",\n \"transaction_type\": \"authorize\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"payment_details\": {\n \"detailed_status\": \"string\"\n },\n \"failure_details\": {\n \"code\": \"string\",\n \"reason\": \"string\"\n },\n \"payment_intent\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": true\n },\n \"capture_mechanism\": \"automatic\",\n \"refund_mechanism\": \"automatic\",\n \"client_parameters\": {\n \"redirect_url\": \"string\",\n \"secret\": \"string\",\n \"token\": \"string\"\n },\n \"next_actions\": [\n \"string\",\n \"string\"\n ],\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"b4c10f69-8f2a-eb16-21af-7a11ec10a31b\"\n }\n }\n },\n \"meta\": {\n \"display_price\": {\n \"amount\": 2825.9416938070526,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"display_refunded_amount\": {\n \"total\": {\n \"amount\": 6946.64638432702,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31f98d09-5a01-4103-8984-1df911f6b238", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction.", "type": "text/plain" }, "type": "any", "value": "string", "key": "transactionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Request could not be processed\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6b53594-e4c7-4358-a9f1-d415af2ee765", "name": "Capture a Transaction", "request": { "name": "Capture a Transaction", "description": { "content": "Use this endpoint to capture a previously authorized payment. In this step, you can also pass in a custom reference, such as the payment reference from your chosen gateway.", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID", "capture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The UUID of the order.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "transactionID", "disabled": false, "description": { "content": "(Required) The UUID of the transaction to capture.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"options\": {\n \"soft_descriptor\": \"string\",\n \"note_to_payer\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8e72b090-6c84-4843-a93b-260b97fdcd6f", "name": "200", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID", "capture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The UUID of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The UUID of the transaction to capture.", "type": "text/plain" }, "type": "any", "value": "string", "key": "transactionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"options\": {\n \"soft_descriptor\": \"string\",\n \"note_to_payer\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"37d82752-ff41-796c-ee3c-3cb313a462c2\",\n \"reference\": \"string\",\n \"name\": \"string\",\n \"custom_reference\": \"string\",\n \"gateway\": \"stripe_payment_intents\",\n \"amount\": 6611.901005283578,\n \"refunded_amount\": 6164.618584994863,\n \"currency\": \"string\",\n \"transaction_type\": \"authorize\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"payment_details\": {\n \"detailed_status\": \"string\"\n },\n \"failure_details\": {\n \"code\": \"string\",\n \"reason\": \"string\"\n },\n \"payment_intent\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": true\n },\n \"capture_mechanism\": \"automatic\",\n \"refund_mechanism\": \"automatic\",\n \"client_parameters\": {\n \"redirect_url\": \"string\",\n \"secret\": \"string\",\n \"token\": \"string\"\n },\n \"next_actions\": [\n \"string\",\n \"string\"\n ],\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"b4c10f69-8f2a-eb16-21af-7a11ec10a31b\"\n }\n }\n },\n \"meta\": {\n \"display_price\": {\n \"amount\": 2825.9416938070526,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"display_refunded_amount\": {\n \"total\": {\n \"amount\": 6946.64638432702,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbe243f3-8d9f-4c51-b78d-5564b053eca9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID", "capture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The UUID of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The UUID of the transaction to capture.", "type": "text/plain" }, "type": "any", "value": "string", "key": "transactionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"options\": {\n \"soft_descriptor\": \"string\",\n \"note_to_payer\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Request could not be processed\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "760dbac4-f23f-4fbd-afb6-b7a31035711c", "name": "Refund a Transaction", "request": { "name": "Refund a Transaction", "description": { "content": "There are two ways to refund; through your payment gateway and mark it refunded in Commerce Manager, or directly through Commerce Manager or API.\n\n* Mark as Refunded: You can manually mark a transaction as refunded. Before you can mark the order as refunded, you need to handle the actual refund on your side with your payment provider. Mark as Refunded is a full refund made to the transaction.\n* Refund through Composable Commerce: You can process a full or partial refund to a supported payment provider directly from Commerce Manager or API by providing the refund amount. When you start the refund process, the request is directly sent to the payment gateway.\n\n:::caution\n\nIf you use manual gateway for partial or full refund, you need to handle the actual refund on your side with your payment provider.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The UUID of the order.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "transactionID", "disabled": false, "description": { "content": "(Required) The UUID of the transaction you want to refund.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"amount\": 7448.403986704959,\n \"options\": {\n \"note\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8073755c-6571-477a-9156-fe394e8f4915", "name": "200", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The UUID of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The UUID of the transaction you want to refund.", "type": "text/plain" }, "type": "any", "value": "string", "key": "transactionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"amount\": 7448.403986704959,\n \"options\": {\n \"note\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"37d82752-ff41-796c-ee3c-3cb313a462c2\",\n \"reference\": \"string\",\n \"name\": \"string\",\n \"custom_reference\": \"string\",\n \"gateway\": \"stripe_payment_intents\",\n \"amount\": 6611.901005283578,\n \"refunded_amount\": 6164.618584994863,\n \"currency\": \"string\",\n \"transaction_type\": \"authorize\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"payment_details\": {\n \"detailed_status\": \"string\"\n },\n \"failure_details\": {\n \"code\": \"string\",\n \"reason\": \"string\"\n },\n \"payment_intent\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": true\n },\n \"capture_mechanism\": \"automatic\",\n \"refund_mechanism\": \"automatic\",\n \"client_parameters\": {\n \"redirect_url\": \"string\",\n \"secret\": \"string\",\n \"token\": \"string\"\n },\n \"next_actions\": [\n \"string\",\n \"string\"\n ],\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"b4c10f69-8f2a-eb16-21af-7a11ec10a31b\"\n }\n }\n },\n \"meta\": {\n \"display_price\": {\n \"amount\": 2825.9416938070526,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"display_refunded_amount\": {\n \"total\": {\n \"amount\": 6946.64638432702,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c21c7883-5ea1-4ba1-a001-efabf5a7d878", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The UUID of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The UUID of the transaction you want to refund.", "type": "text/plain" }, "type": "any", "value": "string", "key": "transactionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"amount\": 7448.403986704959,\n \"options\": {\n \"note\": \"string\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e9f4edb-6916-4c0b-866e-bdfd79e6acbc", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID", "refund" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The UUID of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The UUID of the transaction you want to refund.", "type": "text/plain" }, "type": "any", "value": "string", "key": "transactionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"amount\": 7448.403986704959,\n \"options\": {\n \"note\": \"string\"\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 \"errors\": [\n {\n \"detail\": \"Transaction cannot be refunded in its current state\",\n \"status\": \"422\",\n \"title\": \"Unprocessable Entity\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9aee505e-d73b-424d-be44-835686e57db7", "name": "Get Order Transactions", "request": { "name": "Get Order Transactions", "description": { "content": "Get order transactions", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The unique identifier of the order.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "583802ed-996c-4fd9-8bb8-a359a1aa5ae9", "name": "200", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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\": \"ced51d33-9c8d-7364-6948-805b7db4b002\",\n \"reference\": \"string\",\n \"name\": \"string\",\n \"custom_reference\": \"string\",\n \"gateway\": \"cyber_source\",\n \"amount\": 2377.9293641610534,\n \"refunded_amount\": 5403.471517593126,\n \"currency\": \"string\",\n \"transaction_type\": \"refund\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"payment_details\": {\n \"detailed_status\": \"string\"\n },\n \"failure_details\": {\n \"code\": \"string\",\n \"reason\": \"string\"\n },\n \"payment_intent\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 2278.010389473808,\n \"key_4\": false\n },\n \"capture_mechanism\": \"automatic\",\n \"refund_mechanism\": \"manual\",\n \"client_parameters\": {\n \"redirect_url\": \"string\",\n \"secret\": \"string\",\n \"token\": \"string\"\n },\n \"next_actions\": [\n \"string\",\n \"string\"\n ],\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"fdadc5fb-abff-893a-7b4a-003c2bd106c0\"\n }\n }\n },\n \"meta\": {\n \"display_price\": {\n \"amount\": 7907.364456288912,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"display_refunded_amount\": {\n \"total\": {\n \"amount\": 9945.281037668685,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n }\n },\n {\n \"id\": \"773e1a63-ca77-8fdf-4569-c02f78cdc56f\",\n \"reference\": \"string\",\n \"name\": \"string\",\n \"custom_reference\": \"string\",\n \"gateway\": \"card_connect\",\n \"amount\": 3473.4487507177737,\n \"refunded_amount\": 1080.7711065896797,\n \"currency\": \"string\",\n \"transaction_type\": \"authorize\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"payment_details\": {\n \"detailed_status\": \"string\"\n },\n \"failure_details\": {\n \"code\": \"string\",\n \"reason\": \"string\"\n },\n \"payment_intent\": {\n \"key_0\": true,\n \"key_1\": 3978,\n \"key_2\": false,\n \"key_3\": 4404\n },\n \"capture_mechanism\": \"manual\",\n \"refund_mechanism\": \"automatic\",\n \"client_parameters\": {\n \"redirect_url\": \"string\",\n \"secret\": \"string\",\n \"token\": \"string\"\n },\n \"next_actions\": [\n \"string\",\n \"string\"\n ],\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"2750ee20-4379-e56e-8e00-c67151246321\"\n }\n }\n },\n \"meta\": {\n \"display_price\": {\n \"amount\": 7291.708831025383,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"display_refunded_amount\": {\n \"total\": {\n \"amount\": 2510.967586359456,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63e17a0f-0493-4af0-ab9c-5bc9b21b6f79", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Request could not be processed\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef21ea63-8405-422d-a318-6e817faffe70", "name": "Get a Transaction", "request": { "name": "Get a Transaction", "description": { "content": "Retrieves a transaction", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The unique identifier of the order that you require transactions for.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "transactionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "09fc3e2c-4003-434f-9b40-449504fe78dc", "name": "200", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order that you require transactions for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction.", "type": "text/plain" }, "type": "any", "value": "string", "key": "transactionID" } ] }, "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 \"id\": \"da86a9e0-4ce2-9ece-c852-c49ce6827636\",\n \"reference\": \"string\",\n \"name\": \"string\",\n \"custom_reference\": \"string\",\n \"gateway\": \"stripe\",\n \"amount\": 6215.384640189017,\n \"refunded_amount\": 2050.0199782591567,\n \"currency\": \"string\",\n \"transaction_type\": \"purchase\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"payment_details\": {\n \"detailed_status\": \"string\"\n },\n \"failure_details\": {\n \"code\": \"string\",\n \"reason\": \"string\"\n },\n \"payment_intent\": {\n \"key_0\": \"string\",\n \"key_1\": 2681.766363415257\n },\n \"capture_mechanism\": \"manual\",\n \"refund_mechanism\": \"manual\",\n \"client_parameters\": {\n \"redirect_url\": \"string\",\n \"secret\": \"string\",\n \"token\": \"string\"\n },\n \"next_actions\": [\n \"string\",\n \"string\"\n ],\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"6a9fe13c-cc1d-3561-8774-ab08a65edc00\"\n }\n }\n },\n \"meta\": {\n \"display_price\": {\n \"amount\": 4124.692123452769,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"display_refunded_amount\": {\n \"total\": {\n \"amount\": 4657.168715468872,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "491cf850-1142-419f-99df-fd3bb4ec0117", "name": "Cancel a Transaction", "request": { "name": "Cancel a Transaction", "description": { "content": "Use this endpoint to cancel or void a pending or authorized transaction. The transaction can be canceled or voided when it is in `pending` and `completed` statuses.\n\n:::caution\n\nThis endpoint works only for Stripe and PayPal and does not work for manual gateway.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The unique identifier of the order.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "transactionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction to be canceled or voided.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"options\": {},\n \"reason\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "eee7256c-5b89-4779-a717-de53c8b40d61", "name": "200", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction to be canceled or voided.", "type": "text/plain" }, "type": "any", "value": "string", "key": "transactionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"options\": {},\n \"reason\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"0c776d24-85fc-1664-2ad2-b0bd250638eb\",\n \"reference\": \"string\",\n \"name\": \"string\",\n \"custom_reference\": \"string\",\n \"gateway\": \"stripe\",\n \"amount\": 9108.840516747618,\n \"refunded_amount\": 2133.0828885557708,\n \"currency\": \"string\",\n \"transaction_type\": \"refund\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"payment_details\": {\n \"detailed_status\": \"string\"\n },\n \"failure_details\": {\n \"code\": \"string\",\n \"reason\": \"string\"\n },\n \"payment_intent\": {\n \"key_0\": 6613,\n \"key_1\": 8675,\n \"key_2\": true\n },\n \"capture_mechanism\": \"manual\",\n \"refund_mechanism\": \"automatic\",\n \"client_parameters\": {\n \"redirect_url\": \"string\",\n \"secret\": \"string\",\n \"token\": \"string\"\n },\n \"next_actions\": [\n \"string\",\n \"string\"\n ],\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"9840af21-cafe-380f-d646-211e653acf70\"\n }\n }\n },\n \"meta\": {\n \"display_price\": {\n \"amount\": 6645.651220097506,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"display_refunded_amount\": {\n \"total\": {\n \"amount\": 9539.516693516043,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adbe74e6-984a-4693-8d19-4208ed7441d3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "transactions", ":transactionID", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the order.", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction to be canceled or voided.", "type": "text/plain" }, "type": "any", "value": "string", "key": "transactionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"options\": {},\n \"reason\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Custom Discounts", "description": "With custom discounts, you can allow your shoppers to apply discounts from external services to their purchases. To apply custom discounts to carts and cart items, you need to set `custom_discounts_enabled` field to `true` in your [Cart Settings](/docs/api/carts/put-v-2-settings-cart).\n\nYou cannot add custom discounts to an empty cart.\n\n:::caution\n\n- You can apply up to five custom discounts to cart and cart item.\n- The stores that use [simple calculation method](/guides/How-To/Carts/calculate-totals) do not support custom discounts.\n\n:::\n", "item": [ { "id": "aac34f0f-c355-4da8-ac2c-6a03c52eacac", "name": "Bulk Add Custom Discounts to Cart", "request": { "name": "Bulk Add Custom Discounts to Cart", "description": { "content": "The default value for custom discounts on both the cart and cart items is set to 5 if this parameter is not configured in the store. To verify the custom discount limit value, call [Get all settings](/docs/api/settings/get-v-2-settings) endpoint.\n\nTo increase the custom discount value, contact [Elastic Path Support team](https://support.elasticpath.com/hc/en-us).\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "custom-discounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) Specifies the system generated ID for the cart that the shopper created.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"amount\": 5491.5701407566985,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"c7e341e5-43f9-dce5-2886-e84d76cb50a5\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"custom_item\",\n \"id\": \"7cca7ce4-1bca-59f7-9b82-288991978bad\"\n }\n }\n }\n },\n {\n \"amount\": 8357.046228098248,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"948c0fc0-09e5-fb04-b95e-83bbbe3a4dcd\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"custom_item\",\n \"id\": \"f75028d0-f9af-ec6b-aade-485f1668eae9\"\n }\n }\n }\n }\n ],\n \"options\": {\n \"add_all_or_nothing\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0020970e-7f2c-4b15-bb62-1afb94426fd1", "name": "201", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "custom-discounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the system generated ID for the cart that the shopper created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"amount\": 5491.5701407566985,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"c7e341e5-43f9-dce5-2886-e84d76cb50a5\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"custom_item\",\n \"id\": \"7cca7ce4-1bca-59f7-9b82-288991978bad\"\n }\n }\n }\n },\n {\n \"amount\": 8357.046228098248,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"948c0fc0-09e5-fb04-b95e-83bbbe3a4dcd\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"custom_item\",\n \"id\": \"f75028d0-f9af-ec6b-aade-485f1668eae9\"\n }\n }\n }\n }\n ],\n \"options\": {\n \"add_all_or_nothing\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"amount\": 5919.629055259852,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"4f195910-9d6c-884e-17aa-99dc0eaaff6d\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"4998e3e2-4da4-83c6-8cb4-293c1165e014\",\n \"type\": \"custom_item\"\n }\n }\n }\n },\n \"errors\": [\n {\n \"status\": 3909,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"L1N@KtVlnUdfBsvyRONNyDLBeya.crrz\",\n \"component_product_id\": \"e82dfc34-6660-5e01-4969-bdf3356873e1\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 9426,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"NA0afp07@rKUT.nd\",\n \"component_product_id\": \"129de263-f772-0970-41d8-3143492bcf15\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f3a0ef3-315c-4840-991e-d9b079f3871f", "name": "Could not apply custom discount", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "custom-discounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the system generated ID for the cart that the shopper created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"amount\": 5491.5701407566985,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"c7e341e5-43f9-dce5-2886-e84d76cb50a5\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"custom_item\",\n \"id\": \"7cca7ce4-1bca-59f7-9b82-288991978bad\"\n }\n }\n }\n },\n {\n \"amount\": 8357.046228098248,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"948c0fc0-09e5-fb04-b95e-83bbbe3a4dcd\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"custom_item\",\n \"id\": \"f75028d0-f9af-ec6b-aade-485f1668eae9\"\n }\n }\n }\n }\n ],\n \"options\": {\n \"add_all_or_nothing\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "Custom discounts not enabled for this cart", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37e6beba-d874-422e-ad91-7a24cb8b8366", "name": "Could not apply custom discount", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "custom-discounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the system generated ID for the cart that the shopper created.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"amount\": 5491.5701407566985,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"c7e341e5-43f9-dce5-2886-e84d76cb50a5\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"custom_item\",\n \"id\": \"7cca7ce4-1bca-59f7-9b82-288991978bad\"\n }\n }\n }\n },\n {\n \"amount\": 8357.046228098248,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"948c0fc0-09e5-fb04-b95e-83bbbe3a4dcd\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"custom_item\",\n \"id\": \"f75028d0-f9af-ec6b-aade-485f1668eae9\"\n }\n }\n }\n }\n ],\n \"options\": {\n \"add_all_or_nothing\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "Exceeded custom discount limit", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "593aac3b-1bc8-460b-9a32-57500b1c5a48", "name": "Bulk Delete Custom Discounts From Cart", "request": { "name": "Bulk Delete Custom Discounts From Cart", "description": { "content": "Use this endpoint to bulk delete custom discounts from cart.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "custom-discounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) Specifies the unique ID for the cart.", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "2f49a022-4b38-40f4-a35b-81e11b130cdc", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "custom-discounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the unique ID for the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f9b1b2d-6612-494e-9d99-c35d7089c3c6", "name": "Update Custom Discount For Cart", "request": { "name": "Update Custom Discount For Cart", "description": { "content": "Use this endpoint to update a custom discount in your cart.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "custom-discounts", ":customdiscountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) Specifies the unique ID for the cart.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "customdiscountID", "disabled": false, "description": { "content": "(Required) Specifies the ID for the custom discount to be updated.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"amount\": {\n \"amount\": 3213.081365376693,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"cb49404b-91ed-4c65-f7ad-366b815c8457\",\n \"type\": \"custom_item\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a1a17b93-04f8-4cc5-a759-e3b11cf7f675", "name": "200", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "custom-discounts", ":customdiscountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the unique ID for the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) Specifies the ID for the custom discount to be updated.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customdiscountID" } ] }, "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 \"data\": {\n \"amount\": {\n \"amount\": 3213.081365376693,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"cb49404b-91ed-4c65-f7ad-366b815c8457\",\n \"type\": \"custom_item\"\n }\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 \"amount\": 8273.29685700229,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"f1f555f9-1586-692b-43a9-7362bcc30e60\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"d2c7a37c-be0c-f4b0-0433-e8b8dc59f7ad\",\n \"type\": \"cart_item\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c78b1bd5-2947-46fd-b835-48a2861ef21e", "name": "Delete Custom Discount From Cart", "request": { "name": "Delete Custom Discount From Cart", "description": { "content": "Use this endpoint to delete custom discount from cart.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "custom-discounts", ":customdiscountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) Specifies the unique ID for the cart.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "customdiscountID", "disabled": false, "description": { "content": "(Required) Specifies the ID for the custom discount to be deleted.", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "3df37197-8e67-45fa-b831-682120b3451c", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "custom-discounts", ":customdiscountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the unique ID for the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) Specifies the ID for the custom discount to be deleted.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customdiscountID" } ] }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "51641676-c6a9-48fd-a1fd-9e4cfbde9bf4", "name": "Add Custom Discount To Cart Item", "request": { "name": "Add Custom Discount To Cart Item", "description": { "content": "Use this endpoint to add a custom discount to cart item.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "custom-discounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) Specifies the ID for the cart.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "cartitemID", "disabled": false, "description": { "content": "(Required) Specifies the unique identifier for the cart item.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 7031.969404035872,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"ebd939c0-9782-5a9b-187a-7b9ce76009d7\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"04c3bcac-be8c-66c7-796a-56770d9dfe1d\",\n \"type\": \"cart_item\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "22c68bb6-aee7-4ad2-afb2-ca1213576846", "name": "Successful request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "custom-discounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the ID for the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) Specifies the unique identifier for the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 7031.969404035872,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"ebd939c0-9782-5a9b-187a-7b9ce76009d7\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"04c3bcac-be8c-66c7-796a-56770d9dfe1d\",\n \"type\": \"cart_item\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"amount\": 8411.31686534876,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"e3da58f4-bdda-4214-1ee8-5eb37545f833\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"49de8bce-4c1d-59c4-7b0a-bdc6e8f4e5a8\",\n \"type\": \"cart_item\"\n }\n }\n }\n },\n {\n \"amount\": 5402.7029814538,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"d1f3295a-087c-b119-c3ac-14b83fa1a10e\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"2dbb1575-7c04-e337-f05b-faac28c41bdf\",\n \"type\": \"cart_item\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebf27398-7e52-41c9-b506-c13db50a989a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "custom-discounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the ID for the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) Specifies the unique identifier for the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 7031.969404035872,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"ebd939c0-9782-5a9b-187a-7b9ce76009d7\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"04c3bcac-be8c-66c7-796a-56770d9dfe1d\",\n \"type\": \"cart_item\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Custom discounts not enabled for this cart\",\n \"status\": 400,\n \"title\": \"Bad Request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e813143-6c8a-44b7-8fee-9c24481af2d6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "custom-discounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the ID for the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) Specifies the unique identifier for the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 7031.969404035872,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"ebd939c0-9782-5a9b-187a-7b9ce76009d7\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"04c3bcac-be8c-66c7-796a-56770d9dfe1d\",\n \"type\": \"cart_item\"\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 \"errors\": [\n {\n \"detail\": \"Custom discount limit reached for this cart item\",\n \"status\": 422,\n \"title\": \"Limit Reached\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec3a1952-ef20-4d8c-ae19-9545f920f74d", "name": "Update Custom Discount For Cart Item", "request": { "name": "Update Custom Discount For Cart Item", "description": { "content": "Use this endpoint to update a custom discount in your cart item.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "custom-discounts", ":customdiscountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) Specifies the ID for the cart.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "cartitemID", "disabled": false, "description": { "content": "(Required) Specifies the ID for the cart item.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "customdiscountID", "disabled": false, "description": { "content": "(Required) Specifies the ID for the custom discount to be updated.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"amount\": {\n \"amount\": 3213.081365376693,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"cb49404b-91ed-4c65-f7ad-366b815c8457\",\n \"type\": \"custom_item\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4e833fad-44ca-4047-9075-1adb7ce2369d", "name": "200", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "custom-discounts", ":customdiscountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the ID for the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) Specifies the ID for the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" }, { "disabled": false, "description": { "content": "(Required) Specifies the ID for the custom discount to be updated.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customdiscountID" } ] }, "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 \"data\": {\n \"amount\": {\n \"amount\": 3213.081365376693,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"cb49404b-91ed-4c65-f7ad-366b815c8457\",\n \"type\": \"custom_item\"\n }\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 \"amount\": 8273.29685700229,\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"discount_engine\": \"string\",\n \"external_id\": \"string\",\n \"type\": \"string\",\n \"id\": \"f1f555f9-1586-692b-43a9-7362bcc30e60\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"d2c7a37c-be0c-f4b0-0433-e8b8dc59f7ad\",\n \"type\": \"cart_item\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44635685-f235-4718-8b2a-215e87edbd0d", "name": "Delete Custom Discount From Cart Item", "request": { "name": "Delete Custom Discount From Cart Item", "description": { "content": "Use this endpoint to delete custom discount from cart item.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "custom-discounts", ":customdiscountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) Specifies the ID for the cart.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "cartitemID", "disabled": false, "description": { "content": "(Required) Specifies the ID for the cart item.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "customdiscountID", "disabled": false, "description": { "content": "(Required) Specifies the ID for the custom discount to be deleted.", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d988f1ea-9b9e-440d-9081-4312670d460c", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "custom-discounts", ":customdiscountID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the ID for the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) Specifies the ID for the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" }, { "disabled": false, "description": { "content": "(Required) Specifies the ID for the custom discount to be deleted.", "type": "text/plain" }, "type": "any", "value": "string", "key": "customdiscountID" } ] }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Cart Settings", "description": "Use Cart Settings to configure cart behavior for your store, including cart expiry, custom discounts, rule promotions, deferred inventory checks, and cart visibility for admins.\n", "item": [ { "id": "a865bb21-ec4f-4390-8f70-921180d78acf", "name": "Get Cart Settings", "request": { "name": "Get Cart Settings", "description": { "content": "Retrieves cart settings.", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "cart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d70b8377-0bff-4433-998a-3e4a63ac626b", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "settings", "cart" ], "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" } ], "body": "{\n \"data\": {\n \"type\": \"settings\",\n \"id\": \"15419118-44ce-5343-8ff6-574daf52bc6b\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7c0e5e2-ba62-4d33-9b77-ab77943a2e50", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "settings", "cart" ], "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 \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55f1f57a-ce3d-4701-b475-d720de72a435", "name": "Update Cart Settings", "request": { "name": "Update Cart Settings", "description": { "content": "You can modify the cart expiry settings to set it to any number of days up to 365. Any existing carts default to the expiry of 7 days. To update cart settings in Commerce Manager, see [Updating Cart setting](/docs/commerce-manager/settings/general-settings#updating-cart-settings).\n\nWith update cart settings endpoint, you can:\n\n- Enable or disable custom discounts by setting the `custom_discounts_enabled` field to `true`. This allows you to activate your custom discounts from external services. By default, this setting is determined by the cart settings configured for the store.\n- Enable or disable the use of rule promotions within the cart. You can apply this setting either at the store level using the update cart setting endpoint or individually to a specific cart using the [update a cart](/docs/api/carts/update-a-cart) endpoint.\n- Enable or disable deferred inventory checks by setting `defer_inventory_check` to `true`. When set, stock levels are not verified for products in a cart until checkout.\n- Control whether admins can see all carts or only shopper-associated carts by setting `show_all_carts` to `true` or `false`.\n- Enable or disable location-based item separation by setting `separate_items_by_location` to `true`. When enabled, cart items with the same SKU but different locations are kept as separate line items instead of being merged.\n\n:::note\n\nYou cannot use both custom discounts and rule promotions at the same time.\n\n:::\n\n### Errors\n\nThe following error is received if you enable a cart to use both custom discounts and rule promotions:\n\n```json\n{\n \"status\": 422,\n \"title\": \"Cannot use both discounts together\",\n \"detail\": \"Only one discount setting can be set to true at a time.\"\n}\n```", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "cart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"settings\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b7dd1a1b-f2d0-4947-acec-dece144e17e6", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "settings", "cart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"type\": \"settings\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"settings\",\n \"id\": \"15419118-44ce-5343-8ff6-574daf52bc6b\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4393d79-c8e0-4d00-b583-1d65175a06fb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "settings", "cart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"type\": \"settings\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66710375-df09-4c0b-b454-d6ed177f0fac", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "settings", "cart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"type\": \"settings\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bf4172c-dc9a-4c16-9ad0-e31f552f0adc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "settings", "cart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"type\": \"settings\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1728aa29-5c47-4101-a1ee-d07199229d97", "name": "Get Cart Settings by Store ID", "request": { "name": "Get Cart Settings by Store ID", "description": { "content": "Retrieves cart settings for the specified store.", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "cart", ":storeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "storeID", "disabled": false, "description": { "content": "(Required) The store ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bd8a8649-4198-45c9-9dd5-2113cb247a8d", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "settings", "cart", ":storeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The store ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "storeID" } ] }, "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 \"type\": \"settings\",\n \"id\": \"15419118-44ce-5343-8ff6-574daf52bc6b\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3609c722-d8b4-4e01-8c94-3a050521bca4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "settings", "cart", ":storeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The store ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "storeID" } ] }, "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 \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3978ce8-6b2e-474a-8bc9-911855e6cb89", "name": "Update Cart Settings by Store ID", "request": { "name": "Update Cart Settings by Store ID", "description": { "content": "You can modify the cart expiry settings to set it to any number of days up to 365. Any existing carts default to the expiry of 7 days. To update cart settings in Commerce Manager, see [Updating Cart setting](/docs/commerce-manager/settings/general-settings#updating-cart-settings).\n\nWith update cart settings endpoint, you can:\n\n- Enable or disable custom discounts by setting the `custom_discounts_enabled` field to `true`. This allows you to activate your custom discounts from external services. By default, this setting is determined by the cart settings configured for the store.\n- Enable or disable the use of rule promotions within the cart. You can apply this setting either at the store level using the update cart setting endpoint or individually to a specific cart using the [update a cart](/docs/api/carts/update-a-cart) endpoint.\n- Enable or disable deferred inventory checks by setting `defer_inventory_check` to `true`. When set, stock levels are not verified for products in a cart until checkout.\n- Control whether admins can see all carts or only shopper-associated carts by setting `show_all_carts` to `true` or `false`.\n- Enable or disable location-based item separation by setting `separate_items_by_location` to `true`. When enabled, cart items with the same SKU but different locations are kept as separate line items instead of being merged.\n\n:::note\n\nYou cannot use both custom discounts and rule promotions at the same time.\n\n:::\n\n### Errors\n\nThe following error is received if you enable a cart to use both custom discounts and rule promotions:\n\n```json\n{\n \"status\": 422,\n \"title\": \"Cannot use both discounts together\",\n \"detail\": \"Only one discount setting can be set to true at a time.\"\n}\n```", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "cart", ":storeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "storeID", "disabled": false, "description": { "content": "(Required) The store ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"settings\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9ab98144-653d-4aab-af9e-010ad5bf9395", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "settings", "cart", ":storeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The store ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "storeID" } ] }, "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 \"data\": {\n \"type\": \"settings\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"settings\",\n \"id\": \"15419118-44ce-5343-8ff6-574daf52bc6b\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed3139d3-9084-46f7-bcc5-e7c0eaf5778e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "settings", "cart", ":storeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The store ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "storeID" } ] }, "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 \"data\": {\n \"type\": \"settings\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c20ab89e-2e0d-4d0a-9267-7890ae5badcd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "settings", "cart", ":storeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The store ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "storeID" } ] }, "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 \"data\": {\n \"type\": \"settings\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dae7a9ad-d5c2-495d-a0cb-b4c6743a1b48", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v2", "settings", "cart", ":storeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The store ID.", "type": "text/plain" }, "type": "any", "value": "string", "key": "storeID" } ] }, "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 \"data\": {\n \"type\": \"settings\",\n \"cart_expiry_days\": 25,\n \"discounts\": {\n \"custom_discounts_enabled\": false,\n \"use_rule_promotions\": false\n },\n \"inventories\": {\n \"defer_inventory_check\": false\n },\n \"items\": {\n \"separate_items_by_location\": false\n },\n \"show_all_carts\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Tax Items", "description": "Taxes differ by country and can differ within the country by region, state, or province. Each jurisdiction has a unique tax code and rate. If your store serves many jurisdictions, integrate a third-party tax generator to manage taxes. If your store serves a few jurisdictions, you can use the API to define the tax codes and rates in Composable Commerce.\n\nTaxes are calculated after all promotional discounts have been applied. When calculating taxes on a cart or order, you can choose from the following methods for calculating taxes:\n\n - Simple calculation method: Taxes are calculated at the unit level and are rounded to the nearest penny for the unit.\n - Line calculation method: Default. Taxes are calculated at the line level and are rounded to the nearest penny for the line.\n For more information about calculation methods, see [Calculate cart and order totals](/guides/How-To/Carts/calculate-totals).\n\nTax values can be either `rate` or `amount`.\n - `rate` - Represents the tax as a percentage in decimal form.\n - `amount` - Represents a tax amount.\n\n:::note\nTax items can be added and removed using [client_credentials access tokens](/docs/api/authentication/create-an-access-token). Only administrators with `client-credentials` access tokens are able to manage tax items.\n:::\n", "item": [ { "id": "db8db51e-139f-4b59-a30d-1084f79f99ea", "name": "Add Tax Item to Cart", "request": { "name": "Add Tax Item to Cart", "description": { "content": "\nUse this endpoint to add a tax item to a cart.\n\n:::note\n\nThere is a soft limit of 5 unique tax items per cart item at any one time.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "cartitemID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.2\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2131762c-ff93-4b5c-938b-7932b4a4c76f", "name": "Rate-based tax item", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.2\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"662461ad-ddcb-4dbd-8ed7-ade9aa63b5f9\",\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.2\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4367c8f9-98b5-4e30-871f-4ef1916e13b1", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.2\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"3f3b5e26-7e7e-4d2d-a3a7-5e9b1f72fabc\",\n \"type\": \"tax_item\",\n \"code\": \"GST\",\n \"jurisdiction\": \"AU\",\n \"name\": \"Goods and Services Tax\",\n \"amount\": 1000\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58d4f339-9cd4-4450-8544-5d391836eaf3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.2\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 \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "acfd8e26-2f2e-42f2-8aa5-8efaff23005a", "name": "Add Tax Item to Bundle Component", "request": { "name": "Add Tax Item to Bundle Component", "description": { "content": "\nUse this endpoint to add a tax item to a specific bundle component (component product) within a cart item.\n\n:::note\n\nThere is a soft limit of 5 unique tax items per component product at any one time.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "components", ":productID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "cartitemID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "productID", "disabled": false, "description": { "content": "(Required) The unique identifier of the component product within the bundle.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.2\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "95fb206b-051f-45fc-b5e9-f1cbaf254506", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "components", ":productID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the component product within the bundle.", "type": "text/plain" }, "type": "any", "value": "string", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.2\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"4f4e6d37-8c8c-4a1a-b8a3-6cd2efab12de\",\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.2\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "958e9fd6-d6cb-4d11-9e6e-f1a33f1f34d2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "components", ":productID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the component product within the bundle.", "type": "text/plain" }, "type": "any", "value": "string", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.2\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5640114a-133c-4c73-af76-c833e6ae47a6", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "components", ":productID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the component product within the bundle.", "type": "text/plain" }, "type": "any", "value": "string", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.2\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ea9e989-8cf0-4f0b-bf29-c0d8ae868c55", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "components", ":productID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the component product within the bundle.", "type": "text/plain" }, "type": "any", "value": "string", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.2\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 \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc655b5b-1e6c-4bbf-a730-3927122cdc7f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "components", ":productID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the component product within the bundle.", "type": "text/plain" }, "type": "any", "value": "string", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.2\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "935dad6a-7a70-4e47-bfdd-a5a3d0ee7a17", "name": "Update Tax Item on Bundle Component", "request": { "name": "Update Tax Item on Bundle Component", "description": { "content": "Use this endpoint to update a tax item on a specific bundle component (component product) within a cart item. To change tax value from `rate` to `amount`, set `rate` to `null`, then set `amount` value and vice versa.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "components", ":productID", "taxes", ":taxitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "cartitemID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "productID", "disabled": false, "description": { "content": "(Required) The unique identifier of the component product within the bundle.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "taxitemID", "disabled": false, "description": { "content": "(Required) The unique identifier of the tax item on the component product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.18\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6cda21a4-f386-4404-8f0b-858042422ff6", "name": "Updated bundle component tax item (amount)", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "components", ":productID", "taxes", ":taxitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the component product within the bundle.", "type": "text/plain" }, "type": "any", "value": "string", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the tax item on the component product.", "type": "text/plain" }, "type": "any", "value": "string", "key": "taxitemID" } ] }, "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 \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.18\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"7aa2ddad-2c5b-4d9b-9ce9-3e8cff778a10\",\n \"type\": \"tax_item\",\n \"code\": \"GST\",\n \"jurisdiction\": \"AU\",\n \"name\": \"Goods and Services Tax\",\n \"amount\": 1200\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28ac652d-4991-49b0-a98e-c74fe304ec46", "name": "Delete Tax Item from Bundle Component", "request": { "name": "Delete Tax Item from Bundle Component", "description": { "content": "\nUse this endpoint to delete a tax item from a specific bundle component (component product) within a cart item.\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "components", ":productID", "taxes", ":taxitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "cartitemID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "productID", "disabled": false, "description": { "content": "(Required) The unique identifier of the component product within the bundle.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "taxitemID", "disabled": false, "description": { "content": "(Required) The unique identifier of the tax item on the component product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "c2156e8d-a1bb-44ff-9c8c-4783f70d9d06", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "components", ":productID", "taxes", ":taxitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the component product within the bundle.", "type": "text/plain" }, "type": "any", "value": "string", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the tax item on the component product.", "type": "text/plain" }, "type": "any", "value": "string", "key": "taxitemID" } ] }, "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": "1e42b2d2-c144-4212-b655-8b35fbd88f07", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "components", ":productID", "taxes", ":taxitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the component product within the bundle.", "type": "text/plain" }, "type": "any", "value": "string", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the tax item on the component product.", "type": "text/plain" }, "type": "any", "value": "string", "key": "taxitemID" } ] }, "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 \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d18b83d-5d59-4af9-9ba8-e602def5a9a4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "components", ":productID", "taxes", ":taxitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the component product within the bundle.", "type": "text/plain" }, "type": "any", "value": "string", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the tax item on the component product.", "type": "text/plain" }, "type": "any", "value": "string", "key": "taxitemID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4baf1eb-33b5-4ff3-9dc0-57760148e1e3", "name": "Bulk Add Tax Items to Cart", "request": { "name": "Bulk Add Tax Items to Cart", "description": { "content": "Use this endpoint to bulk add tax items to cart items and bundle component products.\n\n:::note\n\nA cart item can only have a maximum of five tax items.\nA bundle component product can only have a maximum of five tax items.\n\n:::\n\n### Bundle Component Taxes\n\nTo add tax items to bundle component products, include a `meta` object with `component_product_id` in each tax item:\n\n```json\n{\n \"data\": [\n {\n \"type\": \"tax_item\",\n \"code\": \"GST\",\n \"name\": \"Goods and Services Tax\",\n \"rate\": 0.1,\n \"meta\": {\n \"component_product_id\": \"12345678-1234-5678-9012-123456789012\"\n },\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"cart-item-id\"\n }\n }\n }\n }\n ]\n}\n```\n\n### Errors\n\n\n`422 Unprocessable Entity`\n\n\nIn this example, when `options.add_all_or_nothing` is set to `true` and if\none of cart items is not found or has reached its maximum tax item limit,\nthe following error response is returned:\n\n\n```json\n\n{\n \"status\": 422,\n \"title\": \"Add all or nothing.\",\n \"detail\": \"Add all or nothing set to (true). Could not bulk add tax items to cart.\"\n }\n\n```\n\n\nIn this example, if you add more than five tax items to the same cart item,\nthe following error response is returned:\n\n\n```json\n\n{\n \"status\": 422,\n \"title\": \"Tax item not added to cart item.\",\n \"detail\": \"Cannot exceed tax item limit of (5) on cart item.\",\n \"meta\": {\n \"id\": \"f88e6370-cb35-40b2-a998-c759f31dec0a\"\n }\n }\n```\n\n\n`404`\n\n\nIn this example, if there is a mismatch between `cart_item`/`custom_item`\nand the `relationships.item.data.type` specified in the bulk add tax item,\nthe following error response is returned:\n\n\n```json\n\n{\n \"data\": [],\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Tax item not added to cart item.\",\n \"detail\": \"Mismatch between bulk tax item type(cart_item) and cart item type(custom_item).\",\n \"meta\": {\n \"id\": \"56aab5d1-1dd4-45ed-88ed-4d0cc396b62d\"\n }\n },\n {\n \"status\": 404,\n \"title\": \"Tax item not added to cart item.\",\n \"detail\": \"Mismatch between bulk tax item type(cart_item) and cart item type(custom_item).\",\n \"meta\": {\n \"id\": \"56aab5d1-1dd4-45ed-88ed-4d0cc396b62d\"\n }\n }\n ]\n}\n\n```\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"name\": \"Value Added Tax\",\n \"jurisdiction\": \"UK\",\n \"rate\": 0.2,\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"5601a4b1-9d13-42d3-8fb7-03b35169d1b6\"\n }\n }\n }\n }\n ],\n \"options\": {\n \"add_all_or_nothing\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2197e318-df4c-4c74-b3fb-65ef944cd0b9", "name": "Bulk add response with generated IDs (rate)", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"name\": \"Value Added Tax\",\n \"jurisdiction\": \"UK\",\n \"rate\": 0.2,\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"5601a4b1-9d13-42d3-8fb7-03b35169d1b6\"\n }\n }\n }\n }\n ],\n \"options\": {\n \"add_all_or_nothing\": false\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\": \"98c2b4de-7f33-4b3a-8f2e-8c1b2a3d4e5f\",\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"name\": \"Value Added Tax\",\n \"jurisdiction\": \"UK\",\n \"rate\": 0.2,\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"5601a4b1-9d13-42d3-8fb7-03b35169d1b6\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87aa4e45-ef08-4748-adf8-29eb010c6d43", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"name\": \"Value Added Tax\",\n \"jurisdiction\": \"UK\",\n \"rate\": 0.2,\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"5601a4b1-9d13-42d3-8fb7-03b35169d1b6\"\n }\n }\n }\n }\n ],\n \"options\": {\n \"add_all_or_nothing\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"2b3c4d5e-6f70-4a8b-9c0d-1e2f3a4b5c6d\",\n \"type\": \"tax_item\",\n \"code\": \"GST\",\n \"name\": \"Goods and Services Tax\",\n \"jurisdiction\": \"AU\",\n \"amount\": 1000,\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"1a2b3c4d-5e6f-7a8b-9c0d-abcdefabcdef\"\n }\n }\n }\n },\n {\n \"id\": \"5e4d3c2b-1a0f-4b8a-9c0d-7f6e5d4c3b2a\",\n \"type\": \"tax_item\",\n \"code\": \"PST\",\n \"name\": \"Provincial Sales Tax\",\n \"jurisdiction\": \"CA-BC\",\n \"amount\": 250,\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"custom_item\",\n \"id\": \"9f8e7d6c-5b4a-3210-fedc-ba9876543210\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c40a5428-d52d-454d-930f-80a8f1170c53", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"name\": \"Value Added Tax\",\n \"jurisdiction\": \"UK\",\n \"rate\": 0.2,\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"cart_item\",\n \"id\": \"5601a4b1-9d13-42d3-8fb7-03b35169d1b6\"\n }\n }\n }\n }\n ],\n \"options\": {\n \"add_all_or_nothing\": false\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 \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d253d10-166d-4c80-8532-d107b71f3694", "name": "Bulk Delete Tax Items from Cart", "request": { "name": "Bulk Delete Tax Items from Cart", "description": { "content": "Use this endpoint to bulk delete all tax items from all cart items and bundle component products in the cart.\n\n:::warning\n\nThis operation will remove ALL tax items from:\n- All cart items in the cart\n- All bundle component products within bundle cart items\n\n:::\n\n### Behavior\n\n- Removes all tax items from every cart item\n- Removes all tax items from every component product in bundle cart items\n- If no tax items exist anywhere in the cart, returns a 404 error\n\n### Errors\n\n`404 Not Found`\n\nIf no tax items exist in the cart (on cart items or component products):\n\n```json\n{\n \"status\": 404,\n \"title\": \"Resource Not Found\",\n \"detail\": \"No tax items exist in the cart\"\n}\n```\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "7f735691-2b80-491b-be92-2be6cb1854e5", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "97542763-f6cb-4758-9cd8-e4a57e215c1c", "name": "Not Found - No tax items exist in the cart", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "taxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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 \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b840d980-41fe-42b0-adeb-00a305a45f58", "name": "Update a Tax Item", "request": { "name": "Update a Tax Item", "description": { "content": "Use this endpoint to update a tax item. To change tax value from `rate` to `amount`, set `rate` to `null`, then set `amount` value and vice versa.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "taxes", ":taxitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "cartitemID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "taxitemID", "disabled": false, "description": { "content": "(Required) The unique identifier of the tax item.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.15\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "51be2069-b46f-40cc-b7d9-34db2545baf7", "name": "Updated tax item (rate)", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "taxes", ":taxitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the tax item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "taxitemID" } ] }, "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 \"data\": {\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.15\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"662461ad-ddcb-4dbd-8ed7-ade9aa63b5f9\",\n \"type\": \"tax_item\",\n \"code\": \"VAT\",\n \"jurisdiction\": \"UK\",\n \"name\": \"Value Added Tax\",\n \"rate\": 0.15\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b4f8160-f6f4-446b-907e-d2695fcc3810", "name": "Delete a Tax Item", "request": { "name": "Delete a Tax Item", "description": { "content": "Use this endpoint to delete a tax item.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "taxes", ":taxitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "cartitemID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "taxitemID", "disabled": false, "description": { "content": "(Required) The unique identifier of the tax item.", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "6a94683e-6759-43a4-b779-a9ead0f53e5f", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "items", ":cartitemID", "taxes", ":taxitemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartitemID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the tax item.", "type": "text/plain" }, "type": "any", "value": "string", "key": "taxitemID" } ] }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Cart Shipping Groups", "description": "", "item": [ { "id": "2ca62db5-f021-4139-9cc9-6c888143196c", "name": "Retrieve all shipping groups for a cart", "request": { "name": "Retrieve all shipping groups for a cart", "description": { "content": "Retrieve all shipping groups for a cart", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c45bf60c-b665-43cb-a82d-4ac9731c8d02", "name": "A list of shipping groups", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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\": \"96b1d104-0d2e-41fd-9543-6c3c5a698959\",\n \"type\": \"shipping_group\",\n \"relation\": \"cart\",\n \"cart_id\": \"96b1d104-0d2e-41fd-9543-6c3c5a698959\",\n \"shipping_type\": \"standard\",\n \"tracking_reference\": \"TRACK123\",\n \"meta\": {\n \"shipping_display_price\": {\n \"total\": {\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"formatted\": \"$10.00\"\n },\n \"base\": {\n \"amount\": 800,\n \"currency\": \"USD\",\n \"formatted\": \"$8.00\"\n },\n \"tax\": {\n \"amount\": 200,\n \"currency\": \"USD\",\n \"formatted\": \"$2.00\"\n },\n \"fees\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n }\n }\n },\n \"address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"ACME Corp\",\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Suite 100\",\n \"city\": \"Portland\",\n \"postcode\": \"97201\",\n \"county\": \"Multnomah\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"instructions\": \"Leave at front door\"\n },\n \"delivery_estimate\": {\n \"start\": \"2024-01-15T00:00:00Z\",\n \"end\": \"2024-01-20T00:00:00Z\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b038a3c1-5eb1-41b3-9e34-811e72ab81cc", "name": "Cart not found", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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 \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd223260-14ed-4320-96d7-b56512d8c2ba", "name": "Create a new shipping group for a cart", "request": { "name": "Create a new shipping group for a cart", "description": { "content": "Create a new shipping group for a cart", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"shipping_type\": \"string\",\n \"tracking_reference\": \"string\",\n \"external_ref\": \"string\",\n \"shipping_price\": {\n \"total\": 8724.787240625856,\n \"base\": 5343.469999084061,\n \"tax\": 6947.764330219948,\n \"fees\": 8322.335239106913,\n \"discount\": 4077.9479854274414\n },\n \"address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"includes_tax\": false,\n \"delivery_estimate\": {\n \"start\": \"1960-11-14T19:10:24.707Z\",\n \"end\": \"2017-01-13T05:18:21.040Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b4dd99e4-5034-4059-aa74-897040d5e4eb", "name": "Shipping group created successfully", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"shipping_type\": \"string\",\n \"tracking_reference\": \"string\",\n \"external_ref\": \"string\",\n \"shipping_price\": {\n \"total\": 8724.787240625856,\n \"base\": 5343.469999084061,\n \"tax\": 6947.764330219948,\n \"fees\": 8322.335239106913,\n \"discount\": 4077.9479854274414\n },\n \"address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"includes_tax\": false,\n \"delivery_estimate\": {\n \"start\": \"1960-11-14T19:10:24.707Z\",\n \"end\": \"2017-01-13T05:18:21.040Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"96b1d104-0d2e-41fd-9543-6c3c5a698959\",\n \"type\": \"shipping_group\",\n \"relation\": \"cart\",\n \"cart_id\": \"96b1d104-0d2e-41fd-9543-6c3c5a698959\",\n \"shipping_type\": \"standard\",\n \"tracking_reference\": \"TRACK123\",\n \"address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"ACME Corp\",\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Suite 100\",\n \"city\": \"Portland\",\n \"postcode\": \"97201\",\n \"county\": \"Multnomah\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"instructions\": \"Leave at front door\"\n },\n \"delivery_estimate\": {\n \"start\": \"2024-01-15T00:00:00Z\",\n \"end\": \"2024-01-20T00:00:00Z\"\n },\n \"created_at\": \"2024-01-10T12:00:00Z\",\n \"updated_at\": \"2024-01-10T12:00:00Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "869f5bb5-1664-4c5b-9e8d-4cc58dcfb409", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"shipping_type\": \"string\",\n \"tracking_reference\": \"string\",\n \"external_ref\": \"string\",\n \"shipping_price\": {\n \"total\": 8724.787240625856,\n \"base\": 5343.469999084061,\n \"tax\": 6947.764330219948,\n \"fees\": 8322.335239106913,\n \"discount\": 4077.9479854274414\n },\n \"address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"includes_tax\": false,\n \"delivery_estimate\": {\n \"start\": \"1960-11-14T19:10:24.707Z\",\n \"end\": \"2017-01-13T05:18:21.040Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Cart Currency Mismatch\",\n \"detail\": \"This cart uses USD, cannot add shipping group with currency EUR\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89ff5e4a-3f8a-4d26-8019-0fcf8543cbbf", "name": "Cart not found", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"shipping_type\": \"string\",\n \"tracking_reference\": \"string\",\n \"external_ref\": \"string\",\n \"shipping_price\": {\n \"total\": 8724.787240625856,\n \"base\": 5343.469999084061,\n \"tax\": 6947.764330219948,\n \"fees\": 8322.335239106913,\n \"discount\": 4077.9479854274414\n },\n \"address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"includes_tax\": false,\n \"delivery_estimate\": {\n \"start\": \"1960-11-14T19:10:24.707Z\",\n \"end\": \"2017-01-13T05:18:21.040Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"Cart not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de3c4f35-b256-4e12-bd80-4433c065033c", "name": "Retrieve a specific shipping group for a cart", "request": { "name": "Retrieve a specific shipping group for a cart", "description": { "content": "Retrieve a specific shipping group for a cart", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartId", "shipping-groups", ":shippingGroupId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartId", "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "shippingGroupId", "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8f257c32-d486-42d3-8a70-61abba09bcba", "name": "Shipping group details", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartId", "shipping-groups", ":shippingGroupId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartId" }, { "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" }, "type": "any", "value": "string", "key": "shippingGroupId" } ] }, "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 \"id\": \"7cfa5b07-092e-4dbe-bbad-55a771a34117\",\n \"type\": \"shipping_group\",\n \"relation\": \"cart\",\n \"cart_id\": \"96b1d104-0d2e-41fd-9543-6c3c5a698959\",\n \"shipping_type\": \"standard\",\n \"tracking_reference\": \"TRACK123\",\n \"address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"ACME Corp\",\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Suite 100\",\n \"city\": \"Portland\",\n \"postcode\": \"97201\",\n \"county\": \"Multnomah\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"instructions\": \"Leave at front door\"\n },\n \"delivery_estimate\": {\n \"start\": \"2024-01-15T00:00:00Z\",\n \"end\": \"2024-01-20T00:00:00Z\"\n },\n \"meta\": {\n \"shipping_display_price\": {\n \"total\": {\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"formatted\": \"$10.00\"\n },\n \"base\": {\n \"amount\": 800,\n \"currency\": \"USD\",\n \"formatted\": \"$8.00\"\n },\n \"tax\": {\n \"amount\": 200,\n \"currency\": \"USD\",\n \"formatted\": \"$2.00\"\n },\n \"fees\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f998ea50-aa21-4a62-b780-10e15385ac44", "name": "Shipping group or cart not found", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartId", "shipping-groups", ":shippingGroupId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartId" }, { "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" }, "type": "any", "value": "string", "key": "shippingGroupId" } ] }, "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 \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"Cart not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5c236f6-79e1-4d46-8ca8-5a1c2f17ff86", "name": "Update a shipping group for a cart", "request": { "name": "Update a shipping group for a cart", "description": { "content": "Update a specific shipping group for a cart", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartId", "shipping-groups", ":shippingGroupId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartId", "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "shippingGroupId", "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_group\",\n \"shipping_type\": \"express\",\n \"tracking_reference\": \"TRACK456\",\n \"shipping_price\": {\n \"base\": 1500,\n \"tax\": 300,\n \"fees\": 200\n },\n \"address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"ACME Corp\",\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Suite 100\",\n \"city\": \"Portland\",\n \"postcode\": \"97201\",\n \"county\": \"Multnomah\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"instructions\": \"Leave at front door\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2f79e275-af4a-4679-a2aa-1f7e74365fbd", "name": "Shipping group updated successfully", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartId", "shipping-groups", ":shippingGroupId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartId" }, { "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" }, "type": "any", "value": "string", "key": "shippingGroupId" } ] }, "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 \"data\": {\n \"type\": \"shipping_group\",\n \"shipping_type\": \"express\",\n \"tracking_reference\": \"TRACK456\",\n \"shipping_price\": {\n \"base\": 1500,\n \"tax\": 300,\n \"fees\": 200\n },\n \"address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"ACME Corp\",\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Suite 100\",\n \"city\": \"Portland\",\n \"postcode\": \"97201\",\n \"county\": \"Multnomah\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"instructions\": \"Leave at front door\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"id\": \"string\",\n \"relation\": \"string\",\n \"cart_id\": \"string\",\n \"order_id\": \"string\",\n \"shipping_type\": \"string\",\n \"tracking_reference\": \"string\",\n \"external_ref\": \"string\",\n \"address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"delivery_estimate\": {\n \"start\": \"1962-08-25T13:04:31.691Z\",\n \"end\": \"1951-07-22T11:32:50.218Z\"\n },\n \"created_at\": \"1982-07-20T13:36:27.304Z\",\n \"updated_at\": \"1999-01-24T03:39:53.588Z\",\n \"relationships\": {\n \"cart\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"57b5a144-f551-f3d9-0466-c2a676bb1815\"\n }\n },\n \"order\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"b48a5792-8eee-1c7e-aaf5-004d24ff40d8\"\n }\n }\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 4942,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 306\n },\n {\n \"amount\": {\n \"amount\": 2376,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 8039\n }\n ],\n \"meta\": {\n \"shipping_display_price\": {\n \"total\": {\n \"amount\": 927.8636281000074,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"base\": {\n \"amount\": 1312.5125689169593,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 2560.871965034333,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"fees\": {\n \"amount\": 4361.917778571201,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 8525.56501910042,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"total_display_price\": {\n \"with_tax\": {\n \"amount\": 7452.855887798004,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 7524.240553491777,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 6353.160784636012,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 3511.0452752307397,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 5154.810014402012,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 2256.9359405179325,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 4749.331747919545,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 1120.9655750155844,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"included\": {\n \"items\": [\n {\n \"type\": \"string\",\n \"id\": \"e068fdb0-c9ef-1ec2-07e7-ae47b3a9acd2\",\n \"quantity\": 7068.786495547121,\n \"product_id\": \"32c179df-9a9b-2267-5c9a-ee0de862fde0\",\n \"subscription_offering_id\": \"617569b4-278d-a48f-c8b4-f6ab87918b60\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"location\": \"string\",\n \"unit_price\": {\n \"amount\": 3502.9210183453065,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 2540.506743211377,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 2498.7939465937957,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"code\": \"string\",\n \"id\": \"a3ea8145-bf45-d824-f320-73952323ec98\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 5558\n },\n {\n \"amount\": {\n \"amount\": 956.3523296608478,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"code\": \"string\",\n \"id\": \"6f160935-0d4f-8329-bb2b-d850223cebc0\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 7592\n }\n ],\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 2463.9384157686563,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 946.0424897714504,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 5251.362372231052,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7385.458970430843,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 4643.445719224106,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4878.7728783590765,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 3429.0876798658833,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 5444.617352549683,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 9074.868428215346,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7837.989321595193,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 7025.015508164878,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 6282.923815941981,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 3573.724191905592,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 3877.77000534538,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 104.57359869569859,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_2\": {\n \"amount\": 6042.284260782413,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_3\": {\n \"amount\": 3011.3822802503987,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 2135.8656585853187,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7531.827256510557,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"cart_item\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"834e8402-f388-81bf-42fc-5c151fb981d6\"\n }\n },\n \"taxes\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"catalog_id\": \"string\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 6742.322785783914\n },\n \"key_1\": {\n \"key_0\": 9838.491123320808,\n \"key_1\": 5389.2465416059495\n },\n \"key_2\": {\n \"key_0\": 6695.804559188692,\n \"key_1\": 211.5727127861633,\n \"key_2\": 8491.563867179215\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 6515\n },\n \"meta\": {\n \"key_0\": 5162.228686820498,\n \"key_1\": true\n },\n \"price\": {\n \"key_0\": true\n },\n \"relationships\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 413.646412558184\n },\n \"meta\": {\n \"key_0\": 5677.90675496509,\n \"key_1\": true\n },\n \"price\": {\n \"key_0\": 1720.1068952917176\n },\n \"relationships\": {\n \"key_0\": 2054.2204254072694,\n \"key_1\": 4691\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 4910.885557502773,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 1976.4400076134648,\n \"type\": \"string\"\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 7389.375266693412,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 8385.806988815355,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 560.4529162249628\n },\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": true\n },\n \"key_1\": {\n \"type\": \"float\",\n \"value\": false\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"string\",\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"6afb1a9a-9817-6549-9a06-0d31a804d255\",\n \"quantity\": 8723.224817117367,\n \"product_id\": \"fe3db077-b9b2-08e7-ab6d-94a54c7e3853\",\n \"subscription_offering_id\": \"bf91d075-3e46-0806-27c9-7e0ac9f15501\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"location\": \"string\",\n \"unit_price\": {\n \"amount\": 1976.877010863054,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 4112.336878433378,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 8841.852573517268,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"code\": \"string\",\n \"id\": \"c23c8e77-1044-60ac-504a-6dae37faba87\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 7799\n },\n {\n \"amount\": {\n \"amount\": 1485.2516946853611,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"code\": \"string\",\n \"id\": \"6ccd662f-0695-0c7f-614e-009d337b3940\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 244\n }\n ],\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 5078.424459098647,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 5781.907829212511,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 5896.227679876911,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 2131.7766580374896,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 5990.747666655434,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9529.175779529438,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 8909.363319789241,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7286.440634337685,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 5923.804125461714,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7426.114269974349,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 9192.902316852698,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 468.1335396182784,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 3441.944285892622,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 2222.760749372612,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 2993.5421210675227,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6515.034359310165,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"cart_item\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"db29c207-b9be-bf59-82a3-5e92d4c1b0ea\"\n }\n },\n \"taxes\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"catalog_id\": \"string\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 2487.3343431496833,\n \"key_1\": 3484.189682859651,\n \"key_2\": 421.6184548773505\n },\n \"key_1\": {\n \"key_0\": 6589.194184958084,\n \"key_1\": 4950.841003256454\n },\n \"key_2\": {\n \"key_0\": 3976.0168839085063\n },\n \"key_3\": {\n \"key_0\": 4252.472130819605,\n \"key_1\": 833.887075466706,\n \"key_2\": 1974.2946145654905,\n \"key_3\": 5597.857592493431\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 6458,\n \"key_1\": false,\n \"key_2\": false\n },\n \"meta\": {\n \"key_0\": false,\n \"key_1\": 1606.4984696401386\n },\n \"price\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": \"string\",\n \"key_3\": 5723.413954342318\n },\n \"relationships\": {\n \"key_0\": 1528.351646866868\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 4237\n },\n \"price\": {\n \"key_0\": false\n },\n \"relationships\": {\n \"key_0\": \"string\",\n \"key_1\": true\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 1556.543190726718,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 2738.1769388158573,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": 4354,\n \"key_1\": 488.43305748796917\n },\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"float\",\n \"value\": false\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": 539.0880367150519\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"string\",\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n }\n }\n ]\n },\n \"errors\": [\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"dZuTxR1d9SljTez@CibftHbuGnwrWoTYhZ.waml\",\n \"component_product_id\": \"9ebe1dc7-bda6-7ed0-58f6-f5e470d9fdfb\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"MhVsQWd4I@ZwtHdCQYAzhyyqHjHlqjrxAZsuDwDf.zxm\",\n \"component_product_id\": \"6306449e-0456-ec34-b57a-1f50681a6199\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a35b91bf-c1dc-4e85-a148-942242348aca", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartId", "shipping-groups", ":shippingGroupId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartId" }, { "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" }, "type": "any", "value": "string", "key": "shippingGroupId" } ] }, "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 \"data\": {\n \"type\": \"shipping_group\",\n \"shipping_type\": \"express\",\n \"tracking_reference\": \"TRACK456\",\n \"shipping_price\": {\n \"base\": 1500,\n \"tax\": 300,\n \"fees\": 200\n },\n \"address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"ACME Corp\",\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Suite 100\",\n \"city\": \"Portland\",\n \"postcode\": \"97201\",\n \"county\": \"Multnomah\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"instructions\": \"Leave at front door\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Cart Currency Mismatch\",\n \"detail\": \"The existing shipping group uses USD, cannot update shipping group with currency EUR\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a293cff-64f6-48ab-b359-981cea18ad5c", "name": "Shipping group or cart not found", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartId", "shipping-groups", ":shippingGroupId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartId" }, { "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" }, "type": "any", "value": "string", "key": "shippingGroupId" } ] }, "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 \"data\": {\n \"type\": \"shipping_group\",\n \"shipping_type\": \"express\",\n \"tracking_reference\": \"TRACK456\",\n \"shipping_price\": {\n \"base\": 1500,\n \"tax\": 300,\n \"fees\": 200\n },\n \"address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"ACME Corp\",\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Suite 100\",\n \"city\": \"Portland\",\n \"postcode\": \"97201\",\n \"county\": \"Multnomah\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"instructions\": \"Leave at front door\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Cart shipping group not found\",\n \"detail\": \"Cart shipping group with ID [7cfa5b07-092e-4dbe-bbad-55a771a34117] not found for cart [abc123]\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15c9a4d8-506c-4478-97a0-a5c4f3b5b73a", "name": "Delete Cart Shipping Group", "request": { "name": "Delete Cart Shipping Group", "description": { "content": "Deletes a shipping group from a cart. You cannot delete a shipping group that is attached to cart items.\nYou must first remove the shipping group from all cart items before deleting the shipping group.\n", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartId", "shipping-groups", ":shippingGroupId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartId", "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "shippingGroupId", "disabled": false, "description": { "content": "(Required) The ID of the shipping group to delete", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "53b0b189-8692-45b6-9562-46123a5ba951", "name": "Successfully deleted the shipping group", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartId", "shipping-groups", ":shippingGroupId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartId" }, { "disabled": false, "description": { "content": "(Required) The ID of the shipping group to delete", "type": "text/plain" }, "type": "any", "value": "string", "key": "shippingGroupId" } ] }, "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": "c8e7a51f-bad3-4cad-822f-1eaebff5bee2", "name": "Cannot delete shipping group that is attached to cart items", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartId", "shipping-groups", ":shippingGroupId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartId" }, { "disabled": false, "description": { "content": "(Required) The ID of the shipping group to delete", "type": "text/plain" }, "type": "any", "value": "string", "key": "shippingGroupId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Cannot delete shipping group\",\n \"detail\": \"Cannot delete shipping groups attached to cart items. Please remove the shipping group from its cart items and try again.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a89552bc-9099-4533-ac3e-19d683bc4204", "name": "Cart or shipping group not found", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartId", "shipping-groups", ":shippingGroupId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the cart", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartId" }, { "disabled": false, "description": { "content": "(Required) The ID of the shipping group to delete", "type": "text/plain" }, "type": "any", "value": "string", "key": "shippingGroupId" } ] }, "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 \"errors\": [\n {\n \"status\": 2055,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"sXpAs-sD2Y52mG@TXMSfQnhRrDSuDKSQ.szxa\",\n \"component_product_id\": \"77d66e6c-b685-c5f9-23ab-31af4f9a7428\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 5083,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"u-g@CExwpIsKQOrelAVXlWobuguzhskfhqJb.jad\",\n \"component_product_id\": \"29632bad-01df-43f5-6f7d-76797bb5cf0b\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Cart Payments", "description": "", "item": [ { "id": "3b83bea5-61de-46c3-95ba-c7c11cc3d5ea", "name": "Update a Payment Intent on a Cart", "request": { "name": "Update a Payment Intent on a Cart", "description": { "content": "Updates the payment information for a specific payment intent on a cart.", "type": "text/plain" }, "url": { "path": [ "v2", "carts", ":cartID", "payments", ":paymentIntentID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "cartID", "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "paymentIntentID", "disabled": false, "description": { "content": "(Required) The unique identifier of the payment intent.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"gateway\": \"string\",\n \"method\": \"string\",\n \"payment_method_types\": [\n \"string\",\n \"string\"\n ],\n \"amount\": 1268,\n \"options\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b0eb5118-299c-4707-a449-8ac197e23e75", "name": "Payment updated successfully", "originalRequest": { "url": { "path": [ "v2", "carts", ":cartID", "payments", ":paymentIntentID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the cart.", "type": "text/plain" }, "type": "any", "value": "string", "key": "cartID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment intent.", "type": "text/plain" }, "type": "any", "value": "string", "key": "paymentIntentID" } ] }, "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 \"data\": {\n \"gateway\": \"string\",\n \"method\": \"string\",\n \"payment_method_types\": [\n \"string\",\n \"string\"\n ],\n \"amount\": 1268,\n \"options\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"contact\": {\n \"email\": \"xeDXFzKwAyR@NFU.edl\"\n },\n \"discount_settings\": {\n \"custom_discounts_enabled\": true,\n \"use_rule_promotions\": false\n },\n \"inventory_settings\": {\n \"defer_inventory_check\": false\n },\n \"item_settings\": {\n \"separate_items_by_location\": true\n },\n \"payment_intent_id\": \"string\",\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": 5799.183081697556\n },\n \"key_1\": {\n \"type\": \"integer\",\n \"value\": true\n },\n \"key_2\": {\n \"type\": \"float\",\n \"value\": 6605.193068470192\n }\n },\n \"snapshot_date\": \"1984-05-08T11:16:27.262Z\",\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"amount\": 8335.403926465655,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 4521.2827265191445,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 1097.22823427588,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 5353.789609953707,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 9179.612124743386,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 1310.4079749712016,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 5450.502653055869,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"expires_at\": \"string\"\n },\n \"promotion_suggestions\": [\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 1268,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 5762,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n },\n {\n \"bundle\": [\n {\n \"auto_add_free_gift\": false,\n \"cart_item_id\": \"string\",\n \"quantity\": 6425,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"auto_add_free_gift\": true,\n \"cart_item_id\": \"string\",\n \"quantity\": 6345,\n \"targets\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"code\": \"string\",\n \"info\": \"string\",\n \"message\": \"string\",\n \"promotion_id\": \"string\"\n }\n ]\n },\n \"relationships\": {\n \"customers\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"00c38ee6-a1ad-f92e-c207-466e418faf04\"\n },\n {\n \"type\": \"string\",\n \"id\": \"b71ccf30-6c9d-1dd6-7702-02110fbde8ca\"\n }\n ]\n },\n \"items\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"d9e07c05-8b8f-8b73-0bf3-f387e5a54ec6\"\n },\n {\n \"type\": \"string\",\n \"id\": \"6919c16a-323d-3efd-436f-739e234d3ebb\"\n }\n ]\n },\n \"accounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"e6494c38-1c85-1612-aa4f-84d6640d48df\"\n },\n {\n \"type\": \"string\",\n \"id\": \"1e134a7e-210e-9b2d-e2cd-8af245c58ac4\"\n }\n ]\n },\n \"custom_discounts\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"ddddd9de-ad63-6bc0-6a93-de7a98057d60\"\n },\n {\n \"type\": \"string\",\n \"id\": \"fccca761-c8e3-88d9-cecf-f0897a954631\"\n }\n ]\n },\n \"promotions\": {\n \"data\": [\n {\n \"type\": \"string\",\n \"id\": \"a3e5dcd5-682e-3ff1-4491-8864173fe9f2\"\n },\n {\n \"type\": \"string\",\n \"id\": \"e0fb42e6-aa73-e142-9201-5b9ae96bcd56\"\n }\n ]\n }\n },\n \"type\": \"string\"\n },\n \"included\": {\n \"custom_discounts\": [\n {\n \"type\": \"string\",\n \"id\": \"5c42e1a9-d3e1-5c87-604c-d2038b9e57d4\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 1177.2432667943278,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"31585381-e220-14a0-dfd2-8fc359b36761\",\n \"type\": \"cart_item\"\n }\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"1a5e5206-ba1e-90d8-4c62-35c9197aae1a\",\n \"external_id\": \"string\",\n \"discount_engine\": \"string\",\n \"amount\": {\n \"amount\": 6500.5931659885355,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"description\": \"string\",\n \"discount_code\": \"string\",\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"id\": \"1a80d140-0544-6cb0-a5b6-92c2bb463fde\",\n \"type\": \"cart_item\"\n }\n }\n }\n }\n ],\n \"promotions\": [\n {\n \"type\": \"string\",\n \"id\": \"edc03c37-d6b1-4d48-e417-a55441ee68ea\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1964-08-16T03:07:46.846Z\",\n \"end\": \"1961-07-21T03:04:33.803Z\"\n },\n {\n \"type\": \"string\",\n \"id\": \"6a9e94c9-373c-4b08-c235-0b01eadbb578\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": true,\n \"promotion_type\": \"string\",\n \"promotion_source\": \"string\",\n \"start\": \"1968-09-23T14:15:29.513Z\",\n \"end\": \"1979-10-14T14:46:20.220Z\"\n }\n ]\n },\n \"meta\": {\n \"payment_intent\": {\n \"key_0\": true,\n \"key_1\": 6015,\n \"key_2\": 3149.423768778801\n }\n },\n \"errors\": [\n {\n \"status\": 9866,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"Pt-CPET-v@vJobjBjFIPEZLoXjoE.ey\",\n \"component_product_id\": \"59f7cde3-4669-4e28-750b-e0a37d3a31e7\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": 2437,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"PeE-KXwTfA50@ONyIrEaZmHqVdVkhf.vnp\",\n \"component_product_id\": \"d9548207-f7f4-8a7c-0f51-be17158f2590\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Order Shipping Groups", "description": "", "item": [ { "id": "533bfd03-a12c-4e32-837e-fad7523563c6", "name": "Retrieve all shipping groups for an order", "request": { "name": "Retrieve all shipping groups for an order", "description": { "content": "Retrieve all shipping groups for an order", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "42978bf8-1ca3-48f5-b1eb-4215cd1656bc", "name": "A list of shipping groups", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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\": \"96b1d104-0d2e-41fd-9543-6c3c5a698959\",\n \"type\": \"shipping_group\",\n \"relation\": \"order\",\n \"order_id\": \"96b1d104-0d2e-41fd-9543-6c3c5a698959\",\n \"shipping_type\": \"standard\",\n \"tracking_reference\": \"TRACK123\",\n \"meta\": {\n \"shipping_display_price\": {\n \"total\": {\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"formatted\": \"$10.00\"\n },\n \"base\": {\n \"amount\": 800,\n \"currency\": \"USD\",\n \"formatted\": \"$8.00\"\n },\n \"tax\": {\n \"amount\": 200,\n \"currency\": \"USD\",\n \"formatted\": \"$2.00\"\n },\n \"fees\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n }\n }\n },\n \"address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"ACME Corp\",\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Suite 100\",\n \"city\": \"Portland\",\n \"postcode\": \"97201\",\n \"county\": \"Multnomah\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"instructions\": \"Leave at front door\"\n },\n \"delivery_estimate\": {\n \"start\": \"2024-01-15T00:00:00Z\",\n \"end\": \"2024-01-20T00:00:00Z\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc94f382-caa8-411e-8893-4e8295f3ead6", "name": "Order not found", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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 \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"Order not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fc3b81b-52de-4a92-ba1d-947ae178ada1", "name": "Create a shipping group for an order", "request": { "name": "Create a shipping group for an order", "description": { "content": "Create a new shipping group for an order", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"shipping_type\": \"string\",\n \"tracking_reference\": \"string\",\n \"address\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone_number\": \"string\",\n \"company_name\": \"string\",\n \"line_1\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"postcode\": \"string\",\n \"county\": \"string\",\n \"country\": \"string\",\n \"region\": \"string\",\n \"instructions\": \"string\"\n },\n \"delivery_estimate\": {\n \"start\": \"2019-02-07T14:11:18.046Z\",\n \"end\": \"1986-07-18T07:39:49.155Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d5a18dac-e8f0-4eea-8e26-8160324a47a2", "name": "Shipping group created", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"shipping_type\": \"string\",\n \"tracking_reference\": \"string\",\n \"address\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone_number\": \"string\",\n \"company_name\": \"string\",\n \"line_1\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"postcode\": \"string\",\n \"county\": \"string\",\n \"country\": \"string\",\n \"region\": \"string\",\n \"instructions\": \"string\"\n },\n \"delivery_estimate\": {\n \"start\": \"2019-02-07T14:11:18.046Z\",\n \"end\": \"1986-07-18T07:39:49.155Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"id\": \"string\",\n \"relation\": \"string\",\n \"cart_id\": \"string\",\n \"order_id\": \"string\",\n \"shipping_type\": \"string\",\n \"tracking_reference\": \"string\",\n \"external_ref\": \"string\",\n \"address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"delivery_estimate\": {\n \"start\": \"2000-09-18T10:04:56.913Z\",\n \"end\": \"1992-03-10T21:32:35.684Z\"\n },\n \"created_at\": \"2005-05-21T10:32:19.804Z\",\n \"updated_at\": \"1995-05-22T00:06:40.908Z\",\n \"relationships\": {\n \"cart\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"376fbb61-c58f-8387-580a-585df1ab9796\"\n }\n },\n \"order\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"2a3549ba-664e-9feb-fd91-b69577ac663f\"\n }\n }\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 3628,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 6510\n },\n {\n \"amount\": {\n \"amount\": 8251,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 3070\n }\n ],\n \"meta\": {\n \"shipping_display_price\": {\n \"total\": {\n \"amount\": 4949.146996809423,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"base\": {\n \"amount\": 7039.815545117127,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 270.26955354632287,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"fees\": {\n \"amount\": 9707.458476643471,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 2278.213069902202,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"total_display_price\": {\n \"with_tax\": {\n \"amount\": 7133.26918669525,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 454.84972239665746,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 5178.741293839828,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 6813.051846971077,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 1586.3406181915418,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 6772.004076158435,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 5996.895547294374,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 3558.0783035207332,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7f71f5f-c894-406b-b7f6-76577c938568", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"shipping_type\": \"string\",\n \"tracking_reference\": \"string\",\n \"address\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone_number\": \"string\",\n \"company_name\": \"string\",\n \"line_1\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"postcode\": \"string\",\n \"county\": \"string\",\n \"country\": \"string\",\n \"region\": \"string\",\n \"instructions\": \"string\"\n },\n \"delivery_estimate\": {\n \"start\": \"2019-02-07T14:11:18.046Z\",\n \"end\": \"1986-07-18T07:39:49.155Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Bad Request\",\n \"detail\": \"Invalid request format\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e855640-4ac2-4f7d-b757-088e13fc503d", "name": "Order not found", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"shipping_type\": \"string\",\n \"tracking_reference\": \"string\",\n \"address\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone_number\": \"string\",\n \"company_name\": \"string\",\n \"line_1\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"postcode\": \"string\",\n \"county\": \"string\",\n \"country\": \"string\",\n \"region\": \"string\",\n \"instructions\": \"string\"\n },\n \"delivery_estimate\": {\n \"start\": \"2019-02-07T14:11:18.046Z\",\n \"end\": \"1986-07-18T07:39:49.155Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"Order not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a6227af-2ca4-4b65-be7d-038dbab3ad07", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"shipping_type\": \"string\",\n \"tracking_reference\": \"string\",\n \"address\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone_number\": \"string\",\n \"company_name\": \"string\",\n \"line_1\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"postcode\": \"string\",\n \"county\": \"string\",\n \"country\": \"string\",\n \"region\": \"string\",\n \"instructions\": \"string\"\n },\n \"delivery_estimate\": {\n \"start\": \"2019-02-07T14:11:18.046Z\",\n \"end\": \"1986-07-18T07:39:49.155Z\"\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 \"errors\": [\n {\n \"status\": 422,\n \"title\": \"Unprocessable Entity\",\n \"detail\": \"Cannot create shipping group for this order\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71678df3-fbf9-46f4-a18f-40615c08a316", "name": "Retrieve a specific shipping group for an order", "request": { "name": "Retrieve a specific shipping group for an order", "description": { "content": "Retrieve a specific shipping group for an order", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups", ":shippingGroupID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma-separated list of related resources to include in the response.", "type": "text/plain" }, "key": "include", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "shippingGroupID", "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "025fda61-f5fa-41ad-b5c0-8f7f095ccffd", "name": "Shipping group details", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups", ":shippingGroupID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma-separated list of related resources to include in the response.", "type": "text/plain" }, "key": "include", "value": "string" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" }, "type": "any", "value": "string", "key": "shippingGroupID" } ] }, "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 \"id\": \"7cfa5b07-092e-4dbe-bbad-55a771a34117\",\n \"type\": \"shipping_group\",\n \"relation\": \"order\",\n \"order_id\": \"96b1d104-0d2e-41fd-9543-6c3c5a698959\",\n \"shipping_type\": \"standard\",\n \"tracking_reference\": \"TRACK123\",\n \"address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"ACME Corp\",\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Suite 100\",\n \"city\": \"Portland\",\n \"postcode\": \"97201\",\n \"county\": \"Multnomah\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"instructions\": \"Leave at front door\"\n },\n \"delivery_estimate\": {\n \"start\": \"2024-01-15T00:00:00Z\",\n \"end\": \"2024-01-20T00:00:00Z\"\n },\n \"meta\": {\n \"shipping_display_price\": {\n \"total\": {\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"formatted\": \"$10.00\"\n },\n \"base\": {\n \"amount\": 800,\n \"currency\": \"USD\",\n \"formatted\": \"$8.00\"\n },\n \"tax\": {\n \"amount\": 200,\n \"currency\": \"USD\",\n \"formatted\": \"$2.00\"\n },\n \"fees\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"formatted\": \"$0.00\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c883d800-1c2b-4fbe-aeb8-d30f8e5a6f69", "name": "Shipping group or order not found", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups", ":shippingGroupID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma-separated list of related resources to include in the response.", "type": "text/plain" }, "key": "include", "value": "string" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" }, "type": "any", "value": "string", "key": "shippingGroupID" } ] }, "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 \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\",\n \"detail\": \"Order not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5139a82c-e94c-45e7-ad1b-7497071e9160", "name": "Update a shipping group for an order", "request": { "name": "Update a shipping group for an order", "description": { "content": "Update a shipping group for an order", "type": "text/plain" }, "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups", ":shippingGroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "orderID", "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "shippingGroupID", "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_group\",\n \"shipping_type\": \"express\",\n \"tracking_reference\": \"TRACK456\",\n \"address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"ACME Corp\",\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Suite 100\",\n \"city\": \"Portland\",\n \"postcode\": \"97201\",\n \"county\": \"Multnomah\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"instructions\": \"Leave at front door\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "acf8d825-d03d-4032-ac92-bc398ebc020e", "name": "Shipping group updated successfully", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups", ":shippingGroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" }, "type": "any", "value": "string", "key": "shippingGroupID" } ] }, "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 \"data\": {\n \"type\": \"shipping_group\",\n \"shipping_type\": \"express\",\n \"tracking_reference\": \"TRACK456\",\n \"address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"ACME Corp\",\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Suite 100\",\n \"city\": \"Portland\",\n \"postcode\": \"97201\",\n \"county\": \"Multnomah\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"instructions\": \"Leave at front door\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"id\": \"string\",\n \"relation\": \"string\",\n \"cart_id\": \"string\",\n \"order_id\": \"string\",\n \"shipping_type\": \"string\",\n \"tracking_reference\": \"string\",\n \"external_ref\": \"string\",\n \"address\": {\n \"country\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"line_1\": \"string\",\n \"postcode\": \"string\",\n \"region\": \"string\",\n \"company_name\": \"string\",\n \"line_2\": \"string\",\n \"city\": \"string\",\n \"county\": \"string\",\n \"phone_number\": \"string\",\n \"instructions\": \"string\"\n },\n \"delivery_estimate\": {\n \"start\": \"1962-08-25T13:04:31.691Z\",\n \"end\": \"1951-07-22T11:32:50.218Z\"\n },\n \"created_at\": \"1982-07-20T13:36:27.304Z\",\n \"updated_at\": \"1999-01-24T03:39:53.588Z\",\n \"relationships\": {\n \"cart\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"57b5a144-f551-f3d9-0466-c2a676bb1815\"\n }\n },\n \"order\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"b48a5792-8eee-1c7e-aaf5-004d24ff40d8\"\n }\n }\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 4942,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 306\n },\n {\n \"amount\": {\n \"amount\": 2376,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"id\": \"string\",\n \"code\": \"string\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 8039\n }\n ],\n \"meta\": {\n \"shipping_display_price\": {\n \"total\": {\n \"amount\": 927.8636281000074,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"base\": {\n \"amount\": 1312.5125689169593,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 2560.871965034333,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"fees\": {\n \"amount\": 4361.917778571201,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 8525.56501910042,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"total_display_price\": {\n \"with_tax\": {\n \"amount\": 7452.855887798004,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_tax\": {\n \"amount\": 7524.240553491777,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"tax\": {\n \"amount\": 6353.160784636012,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"balance_owing\": {\n \"amount\": 3511.0452752307397,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"paid\": {\n \"amount\": 5154.810014402012,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"authorized\": {\n \"amount\": 2256.9359405179325,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"without_discount\": {\n \"amount\": 4749.331747919545,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping\": {\n \"amount\": 1120.9655750155844,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"shipping_discount\": {\n \"amount\": 0,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"included\": {\n \"items\": [\n {\n \"type\": \"string\",\n \"id\": \"e068fdb0-c9ef-1ec2-07e7-ae47b3a9acd2\",\n \"quantity\": 7068.786495547121,\n \"product_id\": \"32c179df-9a9b-2267-5c9a-ee0de862fde0\",\n \"subscription_offering_id\": \"617569b4-278d-a48f-c8b4-f6ab87918b60\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"location\": \"string\",\n \"unit_price\": {\n \"amount\": 3502.9210183453065,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 2540.506743211377,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 2498.7939465937957,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"code\": \"string\",\n \"id\": \"a3ea8145-bf45-d824-f320-73952323ec98\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": true,\n \"ordinal\": 5558\n },\n {\n \"amount\": {\n \"amount\": 956.3523296608478,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"code\": \"string\",\n \"id\": \"6f160935-0d4f-8329-bb2b-d850223cebc0\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 7592\n }\n ],\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 2463.9384157686563,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 946.0424897714504,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 5251.362372231052,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7385.458970430843,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 4643.445719224106,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 4878.7728783590765,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 3429.0876798658833,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 5444.617352549683,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 9074.868428215346,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7837.989321595193,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 7025.015508164878,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 6282.923815941981,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 3573.724191905592,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 3877.77000534538,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_1\": {\n \"amount\": 104.57359869569859,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_2\": {\n \"amount\": 6042.284260782413,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"key_3\": {\n \"amount\": 3011.3822802503987,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 2135.8656585853187,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7531.827256510557,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"cart_item\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"834e8402-f388-81bf-42fc-5c151fb981d6\"\n }\n },\n \"taxes\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"catalog_id\": \"string\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 6742.322785783914\n },\n \"key_1\": {\n \"key_0\": 9838.491123320808,\n \"key_1\": 5389.2465416059495\n },\n \"key_2\": {\n \"key_0\": 6695.804559188692,\n \"key_1\": 211.5727127861633,\n \"key_2\": 8491.563867179215\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 6515\n },\n \"meta\": {\n \"key_0\": 5162.228686820498,\n \"key_1\": true\n },\n \"price\": {\n \"key_0\": true\n },\n \"relationships\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 413.646412558184\n },\n \"meta\": {\n \"key_0\": 5677.90675496509,\n \"key_1\": true\n },\n \"price\": {\n \"key_0\": 1720.1068952917176\n },\n \"relationships\": {\n \"key_0\": 2054.2204254072694,\n \"key_1\": 4691\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 4910.885557502773,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 1976.4400076134648,\n \"type\": \"string\"\n }\n ]\n },\n \"key_1\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 7389.375266693412,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 8385.806988815355,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": \"string\",\n \"key_1\": 560.4529162249628\n },\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": true\n },\n \"key_1\": {\n \"type\": \"float\",\n \"value\": false\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"string\",\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"6afb1a9a-9817-6549-9a06-0d31a804d255\",\n \"quantity\": 8723.224817117367,\n \"product_id\": \"fe3db077-b9b2-08e7-ab6d-94a54c7e3853\",\n \"subscription_offering_id\": \"bf91d075-3e46-0806-27c9-7e0ac9f15501\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"location\": \"string\",\n \"unit_price\": {\n \"amount\": 1976.877010863054,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"value\": {\n \"amount\": 4112.336878433378,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"discounts\": [\n {\n \"amount\": {\n \"amount\": 8841.852573517268,\n \"currency\": \"string\",\n \"includes_tax\": false\n },\n \"code\": \"string\",\n \"id\": \"c23c8e77-1044-60ac-504a-6dae37faba87\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 7799\n },\n {\n \"amount\": {\n \"amount\": 1485.2516946853611,\n \"currency\": \"string\",\n \"includes_tax\": true\n },\n \"code\": \"string\",\n \"id\": \"6ccd662f-0695-0c7f-614e-009d337b3940\",\n \"promotion_source\": \"string\",\n \"is_cart_discount\": false,\n \"ordinal\": 244\n }\n ],\n \"links\": {},\n \"meta\": {\n \"display_price\": {\n \"with_tax\": {\n \"unit\": {\n \"amount\": 5078.424459098647,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 5781.907829212511,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_tax\": {\n \"unit\": {\n \"amount\": 5896.227679876911,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 2131.7766580374896,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"tax\": {\n \"unit\": {\n \"amount\": 5990.747666655434,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 9529.175779529438,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discount\": {\n \"unit\": {\n \"amount\": 8909.363319789241,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7286.440634337685,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"without_discount\": {\n \"unit\": {\n \"amount\": 5923.804125461714,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 7426.114269974349,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n },\n \"discounts\": {\n \"key_0\": {\n \"amount\": 9192.902316852698,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 468.1335396182784,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"key_1\": {\n \"amount\": 3441.944285892622,\n \"currency\": \"string\",\n \"formatted\": \"string\",\n \"constituents\": {\n \"key_0\": {\n \"amount\": 2222.760749372612,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n }\n },\n \"original_price\": {\n \"unit\": {\n \"amount\": 2993.5421210675227,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n },\n \"value\": {\n \"amount\": 6515.034359310165,\n \"currency\": \"string\",\n \"formatted\": \"string\"\n }\n }\n },\n \"timestamps\": {\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n },\n \"relationships\": {\n \"cart_item\": {\n \"data\": {\n \"type\": \"string\",\n \"id\": \"db29c207-b9be-bf59-82a3-5e92d4c1b0ea\"\n }\n },\n \"taxes\": {\n \"data\": null\n },\n \"promotions\": {\n \"data\": null\n }\n },\n \"catalog_id\": \"string\",\n \"catalog_source\": \"string\",\n \"bundle_configuration\": {\n \"selected_options\": {\n \"key_0\": {\n \"key_0\": 2487.3343431496833,\n \"key_1\": 3484.189682859651,\n \"key_2\": 421.6184548773505\n },\n \"key_1\": {\n \"key_0\": 6589.194184958084,\n \"key_1\": 4950.841003256454\n },\n \"key_2\": {\n \"key_0\": 3976.0168839085063\n },\n \"key_3\": {\n \"key_0\": 4252.472130819605,\n \"key_1\": 833.887075466706,\n \"key_2\": 1974.2946145654905,\n \"key_3\": 5597.857592493431\n }\n },\n \"component_products\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": 6458,\n \"key_1\": false,\n \"key_2\": false\n },\n \"meta\": {\n \"key_0\": false,\n \"key_1\": 1606.4984696401386\n },\n \"price\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": \"string\",\n \"key_3\": 5723.413954342318\n },\n \"relationships\": {\n \"key_0\": 1528.351646866868\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"attributes\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 4237\n },\n \"price\": {\n \"key_0\": false\n },\n \"relationships\": {\n \"key_0\": \"string\",\n \"key_1\": true\n }\n }\n ]\n },\n \"components\": {\n \"key_0\": {\n \"name\": \"string\",\n \"options\": [\n {\n \"id\": \"string\",\n \"quantity\": 1556.543190726718,\n \"type\": \"string\"\n },\n {\n \"id\": \"string\",\n \"quantity\": 2738.1769388158573,\n \"type\": \"string\"\n }\n ]\n }\n },\n \"custom_inputs\": {\n \"key_0\": 4354,\n \"key_1\": 488.43305748796917\n },\n \"custom_attributes\": {\n \"key_0\": {\n \"type\": \"float\",\n \"value\": false\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": 539.0880367150519\n }\n },\n \"shipping_group_id\": \"string\",\n \"promotion_source\": \"string\",\n \"subscription_configuration\": {\n \"plan\": \"string\",\n \"pricing_option\": \"string\"\n }\n }\n ]\n },\n \"errors\": [\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"dZuTxR1d9SljTez@CibftHbuGnwrWoTYhZ.waml\",\n \"component_product_id\": \"9ebe1dc7-bda6-7ed0-58f6-f5e470d9fdfb\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"id\": \"string\",\n \"ids\": [\n \"string\",\n \"string\"\n ],\n \"item_ids\": [\n \"string\",\n \"string\"\n ],\n \"shipping_group_id\": \"string\",\n \"shipping_group_ids\": [\n \"string\",\n \"string\"\n ],\n \"cart_id\": \"string\",\n \"code\": \"string\",\n \"order_id\": \"string\",\n \"sku\": \"string\",\n \"email\": \"MhVsQWd4I@ZwtHdCQYAzhyyqHjHlqjrxAZsuDwDf.zxm\",\n \"component_product_id\": \"6306449e-0456-ec34-b57a-1f50681a6199\",\n \"error-meta-key\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8f260cf-ff2c-4a00-b501-bf06936ac984", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups", ":shippingGroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" }, "type": "any", "value": "string", "key": "shippingGroupID" } ] }, "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 \"data\": {\n \"type\": \"shipping_group\",\n \"shipping_type\": \"express\",\n \"tracking_reference\": \"TRACK456\",\n \"address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"ACME Corp\",\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Suite 100\",\n \"city\": \"Portland\",\n \"postcode\": \"97201\",\n \"county\": \"Multnomah\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"instructions\": \"Leave at front door\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Date Logic Discrepancy\",\n \"detail\": \"The start date cannot occur after the end date\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6319e5e4-4006-4583-bec4-3ce6a9750cb3", "name": "Shipping group or order not found", "originalRequest": { "url": { "path": [ "v2", "orders", ":orderID", "shipping-groups", ":shippingGroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the order", "type": "text/plain" }, "type": "any", "value": "string", "key": "orderID" }, { "disabled": false, "description": { "content": "(Required) The ID of the shipping group", "type": "text/plain" }, "type": "any", "value": "string", "key": "shippingGroupID" } ] }, "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 \"data\": {\n \"type\": \"shipping_group\",\n \"shipping_type\": \"express\",\n \"tracking_reference\": \"TRACK456\",\n \"address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"(555) 555-1234\",\n \"company_name\": \"ACME Corp\",\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Suite 100\",\n \"city\": \"Portland\",\n \"postcode\": \"97201\",\n \"county\": \"Multnomah\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"instructions\": \"Leave at front door\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Group not found\",\n \"detail\": \"Group with ID [7cfa5b07-092e-4dbe-bbad-55a771a34117] not found for order [abc123]\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Currencies", "description": ":::caution\n\n- There is a hard limit of 10 currencies per store.\n\n:::\n", "item": [ { "id": "ef239a4f-186f-4556-ab88-6c5c13fa16f1", "name": "Get all Currencies", "request": { "name": "Get all Currencies", "description": { "content": "Fetch all currencies.\n", "type": "text/plain" }, "url": { "path": [ "v2", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "04ce2bda-98e8-48e6-b0c2-99b16f8e08a5", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "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\": \"0c45e4ec-26e0-4043-86e4-c15b9cf985a0\",\n \"type\": \"currency\",\n \"code\": \"GBP\",\n \"exchange_rate\": 1,\n \"format\": \"£{price}\",\n \"decimal_point\": \".\",\n \"thousand_separator\": \",\",\n \"decimal_places\": 2,\n \"default\": true,\n \"enabled\": true,\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-11-07T23:04:18.845Z\",\n \"updated_at\": \"2023-11-07T23:04:18.845Z\"\n },\n \"owner\": \"store\"\n }\n },\n {\n \"id\": \"0c45e4ec-26e0-4043-86e4-c15b9cf985a0\",\n \"type\": \"currency\",\n \"code\": \"GBP\",\n \"exchange_rate\": 1,\n \"format\": \"£{price}\",\n \"decimal_point\": \".\",\n \"thousand_separator\": \",\",\n \"decimal_places\": 2,\n \"default\": true,\n \"enabled\": true,\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-11-07T23:04:18.845Z\",\n \"updated_at\": \"2023-11-07T23:04:18.845Z\"\n },\n \"owner\": \"store\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe716c3d-014c-4c11-a40b-699bb24bf2bd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Bad Request\",\n \"detail\": \"The request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "502e9d0a-4b18-409d-bd93-ee4397490c4e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "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 \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da1bb431-c29f-4efe-bd82-b05b75275508", "name": "Create a Currency", "request": { "name": "Create a Currency", "description": { "content": "Create a currency.\n", "type": "text/plain" }, "url": { "path": [ "v2", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"data\": {\n \"code\": \"GBP\",\n \"decimal_places\": 2,\n \"decimal_point\": \".\",\n \"default\": true,\n \"enabled\": true,\n \"exchange_rate\": 1,\n \"format\": \"£{price}\",\n \"thousand_separator\": \",\",\n \"type\": \"currency\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8f70df89-cab1-43ea-8e30-2297358fcc72", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"code\": \"GBP\",\n \"decimal_places\": 2,\n \"decimal_point\": \".\",\n \"default\": true,\n \"enabled\": true,\n \"exchange_rate\": 1,\n \"format\": \"£{price}\",\n \"thousand_separator\": \",\",\n \"type\": \"currency\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"0c45e4ec-26e0-4043-86e4-c15b9cf985a0\",\n \"type\": \"currency\",\n \"code\": \"GBP\",\n \"exchange_rate\": 1,\n \"format\": \"£{price}\",\n \"decimal_point\": \".\",\n \"thousand_separator\": \",\",\n \"decimal_places\": 2,\n \"default\": true,\n \"enabled\": true,\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-11-07T23:04:18.845Z\",\n \"updated_at\": \"2023-11-07T23:04:18.845Z\"\n },\n \"owner\": \"store\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e0e8292-864b-4c27-9fcc-4bc6715645f1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"code\": \"GBP\",\n \"decimal_places\": 2,\n \"decimal_point\": \".\",\n \"default\": true,\n \"enabled\": true,\n \"exchange_rate\": 1,\n \"format\": \"£{price}\",\n \"thousand_separator\": \",\",\n \"type\": \"currency\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Currency already exists\",\n \"detail\": \"The specified currency code already exists\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dbe21cc-5c73-4b10-9cc2-e23fc0c4942e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "currencies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"code\": \"GBP\",\n \"decimal_places\": 2,\n \"decimal_point\": \".\",\n \"default\": true,\n \"enabled\": true,\n \"exchange_rate\": 1,\n \"format\": \"£{price}\",\n \"thousand_separator\": \",\",\n \"type\": \"currency\"\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 \"errors\": [\n {\n \"status\": 422,\n \"title\": \"Currency limit reached\",\n \"detail\": \"You have reached the maximum allowed currency limit of 10\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c7007fe6-a7b9-47d1-b178-881e90313934", "name": "Get a Currency", "request": { "name": "Get a Currency", "description": { "content": "Fetch a currency by its ID.\n", "type": "text/plain" }, "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "currencyID", "disabled": false, "description": { "content": "(Required) The ID for the requested currency.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "07e223e2-e165-4237-ba21-ee63f0d3e825", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the requested currency.", "type": "text/plain" }, "type": "any", "value": "string", "key": "currencyID" } ] }, "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 \"id\": \"0c45e4ec-26e0-4043-86e4-c15b9cf985a0\",\n \"type\": \"currency\",\n \"code\": \"GBP\",\n \"exchange_rate\": 1,\n \"format\": \"£{price}\",\n \"decimal_point\": \".\",\n \"thousand_separator\": \",\",\n \"decimal_places\": 2,\n \"default\": true,\n \"enabled\": true,\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-11-07T23:04:18.845Z\",\n \"updated_at\": \"2023-11-07T23:04:18.845Z\"\n },\n \"owner\": \"store\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f199463-40ed-427a-9974-ab4180ca7507", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the requested currency.", "type": "text/plain" }, "type": "any", "value": "string", "key": "currencyID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Bad Request\",\n \"detail\": \"The request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9c4fbdf-f6f1-45fa-b111-c70eeace8f58", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the requested currency.", "type": "text/plain" }, "type": "any", "value": "string", "key": "currencyID" } ] }, "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 \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "831db7c0-6a8e-4e41-ace0-9bf25095a7fa", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the requested currency.", "type": "text/plain" }, "type": "any", "value": "string", "key": "currencyID" } ] }, "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 \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Currency not found\",\n \"detail\": \"The requested currency could not be found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3514612-b481-4047-947b-9202c4389b76", "name": "Update a Currency", "request": { "name": "Update a Currency", "description": { "content": "Update a currency.\n", "type": "text/plain" }, "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "currencyID", "disabled": false, "description": { "content": "(Required) The ID for the requested currency.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"data\": {\n \"default\": true\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f737ee79-cec0-430d-969b-17750833a1bd", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the requested currency.", "type": "text/plain" }, "type": "any", "value": "string", "key": "currencyID" } ] }, "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 \"data\": {\n \"default\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"0c45e4ec-26e0-4043-86e4-c15b9cf985a0\",\n \"type\": \"currency\",\n \"code\": \"GBP\",\n \"exchange_rate\": 1,\n \"format\": \"£{price}\",\n \"decimal_point\": \".\",\n \"thousand_separator\": \",\",\n \"decimal_places\": 2,\n \"default\": true,\n \"enabled\": true,\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-11-07T23:04:18.845Z\",\n \"updated_at\": \"2023-11-07T23:04:18.845Z\"\n },\n \"owner\": \"store\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5163d11c-38fb-4e1c-a3d2-45890682daa1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the requested currency.", "type": "text/plain" }, "type": "any", "value": "string", "key": "currencyID" } ] }, "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 \"data\": {\n \"default\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Bad Request\",\n \"detail\": \"The request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b705e047-d87a-4482-99bb-1c514c5f1802", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the requested currency.", "type": "text/plain" }, "type": "any", "value": "string", "key": "currencyID" } ] }, "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 \"data\": {\n \"default\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3393ab19-c1d5-4d39-a7c3-6668161065e9", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the requested currency.", "type": "text/plain" }, "type": "any", "value": "string", "key": "currencyID" } ] }, "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 \"data\": {\n \"default\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Currency not found\",\n \"detail\": \"The requested currency could not be found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4ce7e92-f7c1-4e4a-98dc-0f2432623493", "name": "Delete a Currency", "request": { "name": "Delete a Currency", "description": { "content": "Delete a currency.\n\n:::caution\n\n- You can’t delete a default currency.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "currencyID", "disabled": false, "description": { "content": "(Required) The ID for the Currency to delete.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "7f659bd4-c28e-435b-9aa3-6944869e67d0", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the Currency to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "currencyID" } ] }, "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": "e2fdf875-adad-458a-af6f-91aa06613a15", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the Currency to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "currencyID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Bad Request\",\n \"detail\": \"The request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b661c35f-6697-4d3b-a7b3-48f8a7c80c3f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "currencies", ":currencyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID for the Currency to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "currencyID" } ] }, "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 \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Currency not found\",\n \"detail\": \"The requested currency could not be found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Custom APIs", "description": "Custom APIs allow you to extend the capabilities of Commerce. With Custom APIs, you can efficiently manage large data sets while benefiting from both simple and complex multidimensional filtering options. Combining Custom APIs with [Composer](/docs/composer/index) enables you to deploy custom behaviors and integrations, allowing you to implement capabilities unique to your business without having to build and host that functionality from scratch.\n\nA Custom API is composed of one or more [Custom Fields](/docs/api/commerce-extensions/custom-fields) and allows you to create [Entries](/docs/api/commerce-extensions/custom-api-entries). In database terms, a Custom API can be thought of as a table, with fields representing the columns of the table, and entries serving as the database records.\n\n## Custom APIs vs Non-Core Flows\n\nCustom APIs are the next generation of Non-Core Flows. Here is a comparison of current features of Non-Core Flows and Custom APIs. This will be updated as we release more capabilities.\n\n| Feature | Non-Core Flows | Commerce Extensions |\n|---------------------------------------------------------------------------------------------------------------------------|----------------|----------------------------------------------------------------|\n| Build new APIs | ✅ | ✅ |\n| Access Level | Implicit | [Customizable](/docs/api/permissions/custom-api-role-policies) |\n| [Filtering](/docs/api/commerce-extensions/list-custom-api-entries#filtering) | ⛔️ | ✅ |\n| [Sorting](/docs/api/commerce-extensions/list-custom-api-entries#sorting) | ⛔️ | ✅ |\n| [Events](/docs/api/commerce-extensions/custom-api-entries#events) | ⛔️ | ✅ |\n| [Conditional Updates](/guides/How-To/commerce-extensions/create-a-multilocation-inventories-resource#conditional-updates) | ⛔️ | ✅ |\n\nThe [Custom Fields Overview](/docs/api/commerce-extensions/custom-fields) lists the comparison of different types and validation available in Custom APIs vs Non-Core Flows.\n", "item": [ { "id": "ca329263-9c09-40c5-b2f0-c69655a3b4cf", "name": "Create a Custom API", "request": { "name": "Create a Custom API", "description": { "content": "Create a Custom API", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_api\",\n \"name\": \"Wishlists\",\n \"description\": \"Specifies the description for this Custom API.\",\n \"slug\": \"wishlists\",\n \"api_type\": \"wishlist_ext\",\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"custom_api\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "68cdf233-dde6-4ecd-966f-c8dd519d1876", "name": "A Custom API", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_api\",\n \"name\": \"Wishlists\",\n \"description\": \"Specifies the description for this Custom API.\",\n \"slug\": \"wishlists\",\n \"api_type\": \"wishlist_ext\",\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"custom_api\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"0b6ef596-c258-585c-7baa-88c5ca5439f1\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"slug\": \"wfjfta1v652xlw2p0\",\n \"api_type\": \"5cct_jm_4l_ext\",\n \"allow_upserts\": false,\n \"presentation\": {\n \"page\": \"string\",\n \"section\": null\n },\n \"links\": {\n \"self\": null\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n },\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"api_location\"\n },\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"api_location\"\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41f9c866-1c90-43ff-a740-9869f51cde8d", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_api\",\n \"name\": \"Wishlists\",\n \"description\": \"Specifies the description for this Custom API.\",\n \"slug\": \"wishlists\",\n \"api_type\": \"wishlist_ext\",\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"custom_api\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5440907-ce86-4931-b28f-998235f63cdd", "name": "Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_api\",\n \"name\": \"Wishlists\",\n \"description\": \"Specifies the description for this Custom API.\",\n \"slug\": \"wishlists\",\n \"api_type\": \"wishlist_ext\",\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"custom_api\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"custom_api with the given api_type already exists\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac8153dc-6d17-407c-a019-c968b245ad29", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_api\",\n \"name\": \"Wishlists\",\n \"description\": \"Specifies the description for this Custom API.\",\n \"slug\": \"wishlists\",\n \"api_type\": \"wishlist_ext\",\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"custom_api\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20e4d7dd-71e4-4b1c-91bc-7519097faaed", "name": "List Custom APIs", "request": { "name": "List Custom APIs", "description": { "content": "Retrieves a list of Custom APIs\n\n## Filtering\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) Custom APIs:\n\n| Attribute | Operators | Example |\n|---------------------|-------------------------------|-----------------------------------------------|\n| `id` | `lt`,`le`,`eq`,`gt`,`ge`,`in` | `eq(id,7e067539-6f6c-46e1-8c55-940031b36c6a)` |\n| `created_at` | `lt`,`le`,`eq`,`gt`,`ge` | `ge(created_at,2024-04-29T00:00:00.000Z)` |\n| `updated_at` | `lt`,`le`,`eq`,`gt`,`ge` | `le(updated_at,2024-04-29T00:00:00.000Z)` |\n| `api_type` | `eq`,`like`,`in` | `like(api_type,wishlist*)` |\n| `description` | `eq`,`like` | `like(description,*list*)` |\n| `name` | `eq`,`like` | `eq(name,\"Wishlist\")` |\n| `slug` | `eq`,`like`,`in` | `like(slug,*lists)` |\n| `presentation.page` | `ilike` | `ilike(presentation.page,Home)` |\n\n## Sorting\nThe following attributes are available for sorting. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with `-`, for example, `-updated_at`. The default sort order is `created_at` in descending order.\n- `id`\n- `created_at`\n- `updated_at`\n- `api_type`\n- `name`\n- `slug`\n", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom APIs will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,api_type,-api_type,name,-name,slug,-slug)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "95cafa2b-2970-47e2-8836-3847b4e0024d", "name": "List of Custom APIs", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom APIs will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,api_type,-api_type,name,-name,slug,-slug)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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\": \"33261457-dd66-0394-ff50-b3ffa3db418b\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"slug\": \"frtl_6y3ooq989zbr0120lcqv4opzscbk1z-mkva--6ii\",\n \"api_type\": \"n9qf6m3n7ixs8zce7h6nmn_ext\",\n \"allow_upserts\": false,\n \"presentation\": {\n \"page\": \"string\",\n \"section\": null\n },\n \"links\": {\n \"self\": \"https://xcQibysVitQRQalR.zazdGgqyhwBD1hzUEi85EXBu4kU\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n },\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"custom_api\"\n },\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"api_location\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"932072fb-35a0-6ab7-ce07-8cf9c1eec7c3\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"slug\": \"_vi36cmjpc9qwmzxtxqk_5pvwd2\",\n \"api_type\": \"nsl_09lrytulwg_ext\",\n \"allow_upserts\": false,\n \"presentation\": {\n \"page\": null,\n \"section\": null\n },\n \"links\": {\n \"self\": \"https://qMtQhlNB.rmLjC\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n },\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"api_location\"\n },\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"api_location\"\n }\n ]\n }\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 3945,\n \"total_method\": \"lower_bound\"\n },\n \"page\": {\n \"limit\": 100,\n \"offset\": 0,\n \"current\": 1,\n \"total\": 1\n }\n },\n \"links\": {\n \"current\": \"https://gVgtUiZNaLYOJoQAlDaMMFp.kyYspiL4GTYvRO2f0k76joWp6aJodNbd2CC-yKWl\",\n \"first\": null,\n \"last\": \"http://khkV.dngsTwWj2RGblErVsZjhtieyXLuScWuuofkZy8myDo+f1KdP06dstYK2TPxZgqVS7U.X7\",\n \"next\": null,\n \"prev\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19fbce94-5a17-459b-b0a9-5369bc208503", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom APIs will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,api_type,-api_type,name,-name,slug,-slug)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Invalid filter: unknown field [version] specified in search filter, allowed fields are [api_type created_at description id name slug updated_at]\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9ca6744-cfed-430a-889f-0296ce54731e", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom APIs will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,api_type,-api_type,name,-name,slug,-slug)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d91bdcbc-4bb0-4776-b847-ede983a39856", "name": "Get a Custom API", "request": { "name": "Get a Custom API", "description": { "content": "Get a Custom API", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c601ba43-654b-45f7-9197-615d3c5a2c4d", "name": "A Custom API", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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 \"id\": \"0b6ef596-c258-585c-7baa-88c5ca5439f1\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"slug\": \"wfjfta1v652xlw2p0\",\n \"api_type\": \"5cct_jm_4l_ext\",\n \"allow_upserts\": false,\n \"presentation\": {\n \"page\": \"string\",\n \"section\": null\n },\n \"links\": {\n \"self\": null\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n },\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"api_location\"\n },\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"api_location\"\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8235c4f-d9a5-449e-8d91-b417682ce211", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5074ac1-31ec-40cf-b7e3-4e5fcb4296c7", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb86943f-92e6-42d8-879e-b90b684fed58", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e044369-9d30-426b-a055-5a80e04bb3fc", "name": "Update a Custom API", "request": { "name": "Update a Custom API", "description": { "content": "Update a Custom API", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_api\",\n \"name\": \"Wishlists\",\n \"description\": \"Specifies the description for this Custom API.\",\n \"slug\": \"wishlists\",\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"custom_api\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "620aef25-c116-4c55-bd45-9f19d682f9f2", "name": "A Custom API", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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 \"data\": {\n \"type\": \"custom_api\",\n \"name\": \"Wishlists\",\n \"description\": \"Specifies the description for this Custom API.\",\n \"slug\": \"wishlists\",\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"custom_api\"\n }\n ]\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 \"id\": \"0b6ef596-c258-585c-7baa-88c5ca5439f1\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"slug\": \"wfjfta1v652xlw2p0\",\n \"api_type\": \"5cct_jm_4l_ext\",\n \"allow_upserts\": false,\n \"presentation\": {\n \"page\": \"string\",\n \"section\": null\n },\n \"links\": {\n \"self\": null\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n },\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"api_location\"\n },\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"api_location\"\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc67d2dc-49d8-44b0-9bd5-9050317b1cda", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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 \"data\": {\n \"type\": \"custom_api\",\n \"name\": \"Wishlists\",\n \"description\": \"Specifies the description for this Custom API.\",\n \"slug\": \"wishlists\",\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"custom_api\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29dc0f53-ef35-49cf-a82c-8c725b6719eb", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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 \"data\": {\n \"type\": \"custom_api\",\n \"name\": \"Wishlists\",\n \"description\": \"Specifies the description for this Custom API.\",\n \"slug\": \"wishlists\",\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"custom_api\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b0ded1e-2f5d-4374-aa4a-02ceb227bf60", "name": "Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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 \"data\": {\n \"type\": \"custom_api\",\n \"name\": \"Wishlists\",\n \"description\": \"Specifies the description for this Custom API.\",\n \"slug\": \"wishlists\",\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"custom_api\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"custom_api with the given api_type already exists\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e07af051-82c1-43fd-991a-fb801ab644d9", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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 \"data\": {\n \"type\": \"custom_api\",\n \"name\": \"Wishlists\",\n \"description\": \"Specifies the description for this Custom API.\",\n \"slug\": \"wishlists\",\n \"relationships\": {\n \"parent_apis\": {\n \"data\": [\n {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"custom_api\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53c88992-f116-4f5d-9c3b-8edb46a06ffe", "name": "Delete a Custom API", "request": { "name": "Delete a Custom API", "description": { "content": "Delete a Custom API", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "2b993c6a-d486-44e2-a1ba-ac6332a0bf28", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "98cc84fc-ea27-4ac3-9de2-ac595846f817", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c5cbc31-010d-47cf-9675-22ab10653758", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac2b9cc1-cd08-4d1a-ba59-fd02a434938d", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abd7d7cc-f9ac-46a2-916e-629515c48886", "name": "Get OpenAPI Specification", "request": { "name": "Get OpenAPI Specification", "description": { "content": "Generates an OpenAPI specification based on the Custom APIs and Custom Fields configured for the current store.\nThis dynamically generated specification provides typed schemas for the `/v2/extensions/` endpoints.\n", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "specifications", "openapi" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "33247549-d5be-4cf2-a07b-21556f9ce830", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "specifications", "openapi" ], "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" } ], "body": "{\n \"key_0\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abb0bdf7-5813-4963-a33b-f133ab616995", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "specifications", "openapi" ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b90c1714-e0ac-45e5-92f0-5eab3b5c6b3f", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "specifications", "openapi" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Custom Fields", "description": "A Custom Field represents a single field of data (for example a Product Rating). A Custom API is composed of one or more Custom Fields.\n\nHere is a comparison of different types and validation available in Custom APIs vs Non-Core Flows.\n\n| Feature | Non-Core Flows | Commerce Extensions |\n|-----------------------------------------------|----------------|--------------------------------------------|\n| Data Type: String | ✅ | ✅ |\n| Data Type: Integer | ✅ | ✅ |\n| Data Type: Float | ✅ | ✅ |\n| Data Type: Boolean | ✅ | ✅ |\n| Data Type: List | ⛔ | ✅ |\n| Data Type: Any | ⛔ | ✅ |\n| Data Type: Date & Time | ✅ | ✅ Replaced by Regex Validation (See Below) |\n| Data Type: One To Many | ✅ | Planned |\n| Validation: Regular Expression | ⛔️ | ✅ |\n| Validation: Slug/Email | ✅ | ✅ Replaced by Regex Validation (See Below) |\n| Validation: Min/Max Value | ✅ | ✅ |\n| Validation: Enum(String) | ✅ | ✅ Replaced by Regex validation (See Below) |\n| Validation: Enum(Float/Integer) | ✅ | ⛔️ |\n| Validation: Allow null values | ⛔ | ✅ |\n| Validation: Unique(String) | ⛔ | ✅ |\n| Validation: Unique Case Insensitivity(String) | ⛔ | ✅ |\n| Validation: Immutable | ⛔ | ✅ |\n\n## Validation\n\nWhen [creating](/docs/api/commerce-extensions/create-a-custom-field#request) or [updating](/docs/api/commerce-extensions/update-a-custom-field#request) a Custom Field, `validation` can be used to limit the values that may be stored in the corresponding Custom API Entry.\n\n:::note\n\nAll validation changes, such as those to `allow_null_values` and any type specific rules, apply to new entries only. Existing Custom API Entry records are unaffected until updated.\n\n:::\n\n### Integer Validation\n- `min_value`: Specifies the minimum whole number that can be stored. If set, it must be less than `max_value`.\n- `max_value`: Specifies the maximum whole number that can be stored. If set, it must be greater than `min_value`.\n\nsample integer validation object:\n\n```json\n{\n \"validation\": {\n \"integer\": {\n \"min_value\": 0,\n \"max_value\": 32\n }\n }\n}\n```\nEven if no validation is set, field_type `integer` only supports values between -2^53+1 and 2^53+1. This is because the JSON format doesn't guarantee that values outside this range are portable ([Source](https://datatracker.ietf.org/doc/html/rfc7159#section-6)).\n\n\n\n### Float Validation\n- `min_value`: Specifies the minimum number that can be stored. If set, it must be less than `max_value`.\n- `max_value`: Specifies the maximum number that can be stored. If set, it must be greater than `min_value`.\n\nsample float validation object:\n\n```json\n{\n \"validation\": {\n \"float\": {\n \"min_value\": 0.01,\n \"max_value\": 32.01\n }\n }\n}\n```\n\nThe `float` field_type cannot accurately represent some numbers and so using very small or large numbers might lose precision. We recommend that API clients use either the `integer` field_type if applicable , or the `string` data type if perfect precision or recall is required.\n\n### String Validation\n- `min_length`: Specifies the minimum number of characters that can be stored. If set, it must be greater than 0 and less than `max_length`.\n- `max_length`: Specifies the maximum number of characters that can be stored. If set, it must be greater than 0 and `min_length`.\n- `regex`: An [RE2](https://github.com/google/re2/wiki/Syntax) regular expression used to restrict the specific characters that can be stored. It must be less than 1024 characters.\n- `unique`: Specifies whether the field must have unique constraint or not. It must be `yes` or `no`.\n- `unique_case_insensitivity`: Applies when `unique` is set to `yes`. It controls whether values with different cases (for example, `ABC` and `abc`) should conflict. It must be `true` or `false`.\n sample string validation object:\n\n```json\n{\n \"validation\": {\n \"string\": {\n \"min_length\": 0,\n \"max_length\": 64,\n \"regex\": \"^.+\\\\.(jpg|jpeg|png|gif|pdf)$\",\n \"unique\": \"yes\"\n \"unique_case_insensitivity\": true\n }\n }\n}\n```\nEven if no validation is set, field_type `string` only supports values that are up to `65535` characters long.\n\n#### Date & Time Values With Regular Expressions\n\nWhile Commerce Extensions does not have a native date or time type, you can none-the-less use these values in Commerce Extensions, by using the `string` field type and `regex` validation. To ensure that\nordering is handled properly you should follow the guidance in [RFC 3339 - Section 5.1 Ordering](https://www.rfc-editor.org/rfc/rfc3339.html#section-5.1), namely store the fields in order of least to most precise,\nand in the same timezone, this will ensure that comparison operators (e.g., `gt`) and sorting, work as expected, for example the following regex will force all values to be in seconds in UTC: `^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$`\n\nOne thing to keep in mind is that some libraries, especially when dealing with sub-seconds might only display them if they are non-zero, and you will want to ensure that they are fully padded to the same length.\n\n#### Enum Values with Regular Expressions\n\nYou can ensure that only some values are allowed using the regular expression `^(alpha|bravo|charlie)$`.\n\n#### Slug Values with Regular Expressions\n\nSlugs can be replaced with the regular expression `^[a-z][a-z0-9-]*$`, this will ensure that the field starts with a lower case letter, and then has lower case letters, numbers or hyphens. You can tweak this regular expression as needed to suit your needs.\n\n### Email Validation with Regular Expressions\n\nE-mails can be tricky to validate properly, especially because many services _accept_ e-mails that are not valid, and reject e-mail addresses that are technically valid. Additionally, your own capabilities and purposes might inform your decision (e.g., if you support [i18n addresses](https://datatracker.ietf.org/doc/html/rfc6530) or don't then the set of allowed e-mails changes).\n\n### List Validation\n- `min_length`: Specifies the minimum number of elements that must be in the list.\n- `max_length`: Specifies the maximum number of elements allowed in the list. The maximum supported value is 1000.\n- `allowed_type`: Specifies the primitive type that all elements in the list must be. Valid values are `string`, `integer`, `boolean`, `float`, or `any`. The default is `any`, which allows mixed types. This value cannot be changed after the field is created.\n\nsample list validation object:\n\n```json\n{\n \"validation\": {\n \"list\": {\n \"min_length\": 1,\n \"max_length\": 100,\n \"allowed_type\": \"string\"\n }\n }\n}\n```\n\n### Any Validation\n\nThe `any` field type allows storing arbitrary JSON values including objects, arrays, strings, numbers, booleans, and null. When updating an entry, the `any` field value is completely replaced, not merged. Filtering is not supported on `any` fields.\n\nsample any validation object:\n\n```json\n{\n \"validation\": {\n \"any\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n}\n```\n\n### Null Values\n\nAll Custom Fields can be configured to restrict the storage of `null` values for that field on a Custom API Entry. By default, this is `true`.\n\nsample validation object :\n\n```json\n{\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": false,\n \"immutable\": false\n }\n }\n}\n```\n\n### Immutable\n\nWhen [creating](/docs/api/commerce-extensions/create-a-custom-field#request) a Custom Field, it can be configured to be `immutable`. When set to true, the value of this field can be specified only during POST requests and cannot be modified during PUT requests. By default, this is `false`.\n\nsample validation object :\n\n```json\n{\n \"validation\": {\n \"boolean\": {\n \"immutable\": false\n }\n }\n}\n```\n\n## Presentation\n\nWhen [creating](/docs/api/commerce-extensions/create-a-custom-field#request) or [updating](/docs/api/commerce-extensions/update-a-custom-field#request) a Custom Field, `presentation` can be used to influence the layout and order of fields within Commerce Manager. It does not affect the order of keys within JSON, nor influence any behaviour outside of Commerce Manager.\n\n## Reserved Slugs\n\nThe following values cannot be used as a `slug` in a Custom Field.\n\n- slug\n- type\n- id\n- meta\n- created_at\n- updated_at\n- links\n- relationships\n- attributes\n- attribute\n- dimension\n- dimensions\n- weight\n- weights\n", "item": [ { "id": "3d13f83c-5bdd-4c05-995f-7c2b1b0f032c", "name": "Create a Custom Field", "request": { "name": "Create a Custom Field", "description": { "content": "Create a Custom Field", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"field_type\": \"boolean\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "42bfed48-5154-44a6-b67f-7a9f11757bc2", "name": "A Custom Field", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"field_type\": \"boolean\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"859aeba1-03c2-4822-bd4c-89afce93d7eb\",\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"field_type\": \"boolean\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n },\n \"links\": {\n \"self\": \"/v2/settings/extensions/custom-apis/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/859aeba1-03c2-4822-bd4c-89afce93d7eb\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b85ac2d1-cfb5-4f49-b0fb-e9c0f836d53e", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"field_type\": \"boolean\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efc23815-52eb-480a-975c-777f9a282431", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"field_type\": \"boolean\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a15d529-40da-4906-8187-d66bc8ceff98", "name": "Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"field_type\": \"boolean\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"custom_api with the given api_type already exists\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "217e8fba-18cc-4432-a707-20169db89da8", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"field_type\": \"boolean\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6196af7-abf9-4753-a8be-6a88a7e7b6c8", "name": "List Custom Fields", "request": { "name": "List Custom Fields", "description": { "content": "Retrieves a list of Custom Fields\n\n## Filtering\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) Custom Fields:\n\n| Attribute | Operators | Example |\n|---------------|-------------------------------|-----------------------------------------------|\n| `id` | `lt`,`le`,`eq`,`gt`,`ge`,`in` | `eq(id,859aeba1-03c2-4822-bd4c-89afce93d7eb)` |\n| `created_at` | `lt`,`le`,`eq`,`gt`,`ge` | `ge(created_at,2024-04-29T00:00:00.000Z)` |\n| `updated_at` | `lt`,`le`,`eq`,`gt`,`ge` | `le(updated_at,2024-04-29T00:00:00.000Z)` |\n| `description` | `eq`,`like` | `like(description,*confidential*)` |\n| `field_type` | `eq`,`in` | `eq(field_type,string)` |\n| `name` | `eq`,`like` | `eq(name,\"Last Name\")` |\n| `slug` | `eq`,`like`,`in` | `like(slug,*private*)` |\n\n## Sorting\nThe following attributes are available for sorting. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with `-`, for example, `-updated_at`. The default sort order is `created_at` in descending order.\n- `id`\n- `created_at`\n- `updated_at`\n- `field_type`\n- `name`\n- `slug`\n", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom Fields will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,field_type,-field_type,name,-name,slug,-slug)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4507ba2e-95a0-464d-9513-64cf355263e2", "name": "List of Custom Fields", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom Fields will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,field_type,-field_type,name,-name,slug,-slug)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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\": \"a9d6f2f6-c418-985b-adc0-520f98a395f2\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"slug\": \"string\",\n \"field_type\": \"float\",\n \"use_as_url_slug\": false,\n \"presentation\": {\n \"sort_order\": 10\n },\n \"links\": {\n \"self\": null\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n },\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n },\n {\n \"id\": \"ac158005-69a4-aba1-c0dc-05aa2cdff0f3\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"slug\": \"string\",\n \"field_type\": \"string\",\n \"use_as_url_slug\": false,\n \"presentation\": {\n \"sort_order\": 10\n },\n \"links\": {\n \"self\": \"http://gZzCJncgCZqRNmOxo.vtmwDXAfOkhSZ4Dh-u6-tCnd\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n },\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 5218,\n \"total_method\": \"lower_bound\"\n },\n \"page\": {\n \"limit\": 100,\n \"offset\": 0,\n \"current\": 1,\n \"total\": 1\n }\n },\n \"links\": {\n \"current\": \"http://HCAlfSMbrsljvGtmfGvC.qvYUHM-tUvMAjTlHSJaTYAaxx-eXte\",\n \"first\": \"https://AKb.hddoshgByVfo05z.RFy.dxd7Ea-VgPGh1Tr+51TqN,,zXcAIHQWxeswLg8X6fmv2pJ\",\n \"last\": null,\n \"next\": null,\n \"prev\": \"https://pWLsKxAwGhQjvJjxi.qbontrOEpKAX4hhM\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4937a127-707a-4e7e-aa20-514dbe5f9619", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom Fields will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,field_type,-field_type,name,-name,slug,-slug)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Invalid filter: unknown field [version] specified in search filter, allowed fields are [api_type created_at description id name slug updated_at]\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8037d3f0-df1b-460c-a448-c8f2196bb438", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom Fields will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,field_type,-field_type,name,-name,slug,-slug)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e88b10e-b9be-4b8d-bf77-bbc014c3c36a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom Fields will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,field_type,-field_type,name,-name,slug,-slug)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54cc4c31-fda7-4f7d-8455-62c28c190da7", "name": "Get a Custom Field", "request": { "name": "Get a Custom Field", "description": { "content": "Get a Custom Field", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" } }, { "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5e8f72e3-42fc-4a95-8933-3a0ae2e5e686", "name": "A Custom Field", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" }, "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id" } ] }, "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 \"id\": \"859aeba1-03c2-4822-bd4c-89afce93d7eb\",\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"field_type\": \"boolean\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n },\n \"links\": {\n \"self\": \"/v2/settings/extensions/custom-apis/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/859aeba1-03c2-4822-bd4c-89afce93d7eb\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3200e6a5-00e6-44b7-91dd-f2eac7133dfc", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" }, "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18d0c436-b8e7-42b8-b6eb-089c6d5d13aa", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" }, "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "652a1a6c-8835-44fd-b7a1-2d58637d1bda", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" }, "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6ec87bf-5062-4617-9bd6-118a4cdc53bb", "name": "Update a Custom Field", "request": { "name": "Update a Custom Field", "description": { "content": "Update a Custom Field", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" } }, { "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "40663b43-a2eb-4484-b240-3fb9452d34e5", "name": "A Custom Field", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" }, "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id" } ] }, "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 \"data\": {\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\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 \"id\": \"859aeba1-03c2-4822-bd4c-89afce93d7eb\",\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"field_type\": \"boolean\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n },\n \"links\": {\n \"self\": \"/v2/settings/extensions/custom-apis/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/859aeba1-03c2-4822-bd4c-89afce93d7eb\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2746986a-a0d7-492e-b7ea-6d5af9b7ed78", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" }, "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id" } ] }, "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 \"data\": {\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73a91b78-5f32-4c80-b76a-ee73cab45fc2", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" }, "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id" } ] }, "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 \"data\": {\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aef0ba44-a375-4a89-8363-50133d35b313", "name": "Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" }, "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id" } ] }, "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 \"data\": {\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"custom_api with the given api_type already exists\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85d5b3f0-778f-4bfb-b00d-4d66490cea8d", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" }, "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id" } ] }, "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 \"data\": {\n \"type\": \"custom_field\",\n \"name\": \"Keep Purchased Items\",\n \"description\": \"This field stores whether or not to keep purchased items on the wishlist.\",\n \"slug\": \"keep_purchased\",\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\": true,\n \"immutable\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e0615e4-e870-4226-a3e3-974d89b10218", "name": "Delete a Custom Field", "request": { "name": "Delete a Custom Field", "description": { "content": "Delete a Custom Field", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" } }, { "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "38a804bf-c14e-4aab-90dc-97c868b1d957", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" }, "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id" } ] }, "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": "fb86e975-56ae-4fa0-9629-201900e7dc64", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" }, "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b6915b3-f576-4ab1-a2a8-e7f864fe11c7", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" }, "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f173c9b-b11d-4bb4-bd2d-c7b45d9ab76c", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "fields", ":custom-field-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom Field.", "type": "text/plain" }, "type": "any", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "key": "custom-field-id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Custom API Entries", "description": "A **Custom API Entry** is a specific instance of a resource, such as a single wishlist in a Custom API for wishlists.\n\nCustom API Entries can be accessed in two different ways, via the **extension** endpoint, or the **settings** endpoint:\n\n* Extension Endpoint: `/v2/extensions/{custom-api-slug}` - This is the primary endpoint created for use. Most clients should use this endpoint as it adheres to the semantics of the configuration. Retrieve the [OpenAPI Specifications](/docs/api/commerce-extensions/get-open-api-specification) to learn how to interact with this endpoint.\n* Settings Endpoint: `/v2/settings/extensions/custom-apis/{custom-api-id}/entries/` - This endpoint should only be used in cases where you want to interact with your Custom APIs in a generic way in an admin capacity.\n\nCurrently, the distinction between these endpoints is minimal. The extension endpoint uses a slug in the URL path, and the settings endpoint uses an ID. For most use cases involving the new Custom API, we recommend using the extension endpoint.\n\nConceptually, the settings endpoint is analogous to reflection in most programming languages. You use it when you want to operate in a generic way. For example, we used the settings endpoint to build Commerce Manager. Another example is if you need to import and export various types of data from CSV files. Instead of writing multiple scripts for different extension endpoints, you can write one script that operates on the settings endpoint.\n\n## Events\n\nYou can integrate Commerce Extensions with your external systems by observing the appropriate events. For more information, see [Integrations](/docs/api/integrations/integrations-introduction).\n\nGiven you have a Custom API with `api_type` of `wishlist_ext` and you want to perform additional processing when an action is taken, like when a wishlist is created:\n\n```bash\ncurl -X POST https://useast.api.elasticpath.com/v2/extensions/wishlists \\\n -H \"Authorization: Bearer XXXX\" \\\n -H \"Content-Type: application/json\" \\\n -d $ {\n \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 0,\n \"keep_purchased\": false\n }\n }\n```\n\nWhen you [create an integration](/docs/api/integrations/create-integration) with `wishlist_ext.created` in `observes` field.\nThen the configured `webhook` or `aws_sqs` will receive the appropriate message.\n\nYou can configure integrations to observe the following events for your Custom API Entries:\n* Created\n* Updated\n* Deleted\n", "item": [ { "id": "e3a2e304-970e-4a2b-98cf-1d5087560cc7", "name": "Create a Custom API Entry", "request": { "name": "Create a Custom API Entry", "description": { "content": "Create a Custom API Entry", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 0,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "688774e6-b8b7-4eab-9046-264bec284d4b", "name": "A Custom API Entry", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 0,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "A unique identifier representing the current version of the resource. When the resource changes, the ETag value will also change. The ETag hash will be the same value as `etag_id`, and is marked as a weak entity tag string. For example: etag: W/\"5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9\", etag_id: 5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9\n", "type": "text/plain" }, "key": "ETag", "value": "string" } ], "body": "{\n \"data\": {\n \"id\": \"7e067539-6f6c-46e1-8c55-940031b36c6a\",\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 0,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\"\n ],\n \"links\": {\n \"self\": \"/v2/extensions/wishlists/7e067539-6f6c-46e1-8c55-940031b36c6a\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n },\n \"resource_version\\\"\": 0,\n \"data_size\\\"\": 6,\n \"etag_id\\\"\": \"5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70bf6f86-dfa7-470c-9b5b-b6db88442e71", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 0,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eb5982d-5489-4d76-8052-289174618751", "name": "Forbidden. You do not have permission to access this resource.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 0,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"You do not have permission to access this resource.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c842d5f6-e7d3-476b-b9b9-3dfb05edade6", "name": "Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 0,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"custom_api with the given api_type already exists\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "825dfb33-7c2d-406d-8df3-52a9941028c6", "name": "Payload Too Large.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 0,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Request Entity Too Large\",\n \"status\": \"413\",\n \"detail\": \"Maximum entry size reached.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d7724f5-701f-48b6-a5dd-b7dd732b9d14", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 0,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef03691a-d81c-405e-9600-47e697272a5c", "name": "The service is temporarily unavailable. This request can be safely retried.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 0,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"An unknown error occurred\",\n \"status\": \"503\",\n \"title\": \"Service Unavailable\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f78ba861-5046-4769-8889-0a32761d94ae", "name": "List Custom API Entries", "request": { "name": "List Custom API Entries", "description": { "content": "Retrieves a list of Custom API Entries\n\n## Filtering\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) all Custom API Entries:\n\n| Attribute | Operators | Example |\n|---------------|-------------------------------|-----------------------------------------------|\n| `id` | `lt`,`le`,`eq`,`gt`,`ge`,`in` | `eq(id,859aeba1-03c2-4822-bd4c-89afce93d7eb)` |\n| `created_at` | `lt`,`le`,`eq`,`gt`,`ge` | `ge(created_at,2024-04-29T00:00:00.000Z)` |\n| `updated_at` | `lt`,`le`,`eq`,`gt`,`ge` | `le(updated_at,2024-04-29T00:00:00.000Z)` |\n\nThe following operators and attributes may be available for filtering Custom API Entries depending on how the [Custom Fields](/docs/api/commerce-extensions/create-a-custom-field) for that Custom API are configured.\n\n| Field type | Operators |\n|------------|-----------------------------------------------------------|\n| `string` | `lt`,`le`,`eq`,`gt`,`ge`,`in`,`is_null`,`like` |\n| `integer` | `lt`,`le`,`eq`,`gt`,`ge`,`in`,`is_null` |\n| `float` | `lt`,`le`,`gt`,`ge`,`in`,`is_null` |\n| `boolean` | `eq`,`is_null` |\n| `list` | `contains`,`contains_any`,`is_null`,`contains_all`(typed) |\n\nGiven there is a Custom Field with `\"slug\": \"name\"` and `\"field_type\": \"string\"`.\n\nWhen you get all Custom API Entries with query parameter: `?filter=like(name,*wish*)`.\n\nThen you will get all Custom API Entries where `name` contains the string `wish`.\n\n:::warn\n\nFor performance reasons, the `is_null` search operator will **NOT** match entries for a custom_field where the custom_entry was last updated before the custom_field existed. Updating the entry will cause the field to exist and match properly.\n\n:::\n\n\n## Sorting\nThe following attributes are available for sorting. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with `-`, for example, `-updated_at`. The default sort order is `created_at` in descending order.\n- `id`\n- `created_at`\n- `updated_at`\n", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "The method used to calculate the total number of matching entries in the response.\n (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom API Entries will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,null)", "type": "text/plain" }, "key": "sort", "value": "id" }, { "disabled": false, "description": { "content": "Specifies how long in milliseconds the request should be allowed to take. The service will return a 422 if the request takes longer than the specified timeout.\n", "type": "text/plain" }, "key": "timeout", "value": "2751" } ], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4001006e-ef9c-44c1-9b6f-70154d1b516f", "name": "List of Custom API Entries", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "The method used to calculate the total number of matching entries in the response.\n (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom API Entries will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,null)", "type": "text/plain" }, "key": "sort", "value": "id" }, { "disabled": false, "description": { "content": "Specifies how long in milliseconds the request should be allowed to take. The service will return a 422 if the request takes longer than the specified timeout.\n", "type": "text/plain" }, "key": "timeout", "value": "2751" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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\": \"6642c812-7cdf-e705-10a2-4c93f7772f2c\",\n \"type\": \"string\",\n \"links\": {\n \"self\": null\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n },\n \"data_size\": 6,\n \"resource_version\": 4,\n \"etag_id\": \"6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b\"\n },\n \"key_0\": \"string\"\n },\n {\n \"id\": \"5f3b8094-7716-e4a6-0c48-d318c96f7c9a\",\n \"type\": \"string\",\n \"links\": {\n \"self\": \"https://HxZYtxOVjypQVXCZnzreALkSs.lczqMAErPP9PR\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n },\n \"data_size\": 6,\n \"resource_version\": 4,\n \"etag_id\": \"6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b\"\n },\n \"key_0\": true\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 6603,\n \"total_method\": \"observed\"\n },\n \"page\": {\n \"limit\": 100,\n \"offset\": 0,\n \"current\": 1,\n \"total\": 1\n }\n },\n \"links\": {\n \"current\": null,\n \"first\": \"https://SYbRzUDDcSLEpbDEdrwfRKGMPRl.ncNcznOZ39Rn8NJS6iQMZjAzTTuyTbi+Shlp\",\n \"last\": \"http://sqNVmUhWqFxffplO.bnhyNjdZyKo6Rrod7xTU\",\n \"next\": \"http://cUFwgeGnJTMDgZNKAPpAkjXSS.rjqJJN.,pgR,Ez0nl7jJkEqG9f07hzPtZjC5D\",\n \"prev\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85526076-72ad-42fd-86fa-5c66810a5b49", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "The method used to calculate the total number of matching entries in the response.\n (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom API Entries will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,null)", "type": "text/plain" }, "key": "sort", "value": "id" }, { "disabled": false, "description": { "content": "Specifies how long in milliseconds the request should be allowed to take. The service will return a 422 if the request takes longer than the specified timeout.\n", "type": "text/plain" }, "key": "timeout", "value": "2751" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Invalid filter: unknown field [version] specified in search filter, allowed fields are [api_type created_at description id name slug updated_at]\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "932ac390-384a-476e-989a-f6f7cc3acaf1", "name": "Forbidden. You do not have permission to access this resource.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "The method used to calculate the total number of matching entries in the response.\n (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom API Entries will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,null)", "type": "text/plain" }, "key": "sort", "value": "id" }, { "disabled": false, "description": { "content": "Specifies how long in milliseconds the request should be allowed to take. The service will return a 422 if the request takes longer than the specified timeout.\n", "type": "text/plain" }, "key": "timeout", "value": "2751" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"You do not have permission to access this resource.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32b0178f-9ee2-46cd-a8e1-e2f8c3944bb0", "name": "Unprocessable Content. The server couldn't satisfy your request, most likely due to a timeout.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "The method used to calculate the total number of matching entries in the response.\n (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom API Entries will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,null)", "type": "text/plain" }, "key": "sort", "value": "id" }, { "disabled": false, "description": { "content": "Specifies how long in milliseconds the request should be allowed to take. The service will return a 422 if the request takes longer than the specified timeout.\n", "type": "text/plain" }, "key": "timeout", "value": "2751" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Unprocessable Content\",\n \"status\": \"422\",\n \"detail\": \"request timed out after 20000 ms.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95c8d82b-690c-43f2-852e-5a65ad5f5926", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "The method used to calculate the total number of matching entries in the response.\n (This can only be one of lower_bound,observed)", "type": "text/plain" }, "key": "page[total_method]", "value": "lower_bound" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(name,\"My Wishlist\")" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom API Entries will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at,null)", "type": "text/plain" }, "key": "sort", "value": "id" }, { "disabled": false, "description": { "content": "Specifies how long in milliseconds the request should be allowed to take. The service will return a 422 if the request takes longer than the specified timeout.\n", "type": "text/plain" }, "key": "timeout", "value": "2751" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d8e35f37-a649-4b85-8936-248c260fe3a5", "name": "Get a Custom API Entry", "request": { "name": "Get a Custom API Entry", "description": { "content": "Get a Custom API Entry", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" } }, { "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8e4559d1-be12-45b2-bfc5-525951fc28bf", "name": "A Custom API Entry", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "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": "A unique identifier representing the current version of the resource. When the resource changes, the ETag value will also change. The ETag hash will be the same value as `etag_id`, and is marked as a weak entity tag string. For example: etag: W/\"5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9\", etag_id: 5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9\n", "type": "text/plain" }, "key": "ETag", "value": "string" } ], "body": "{\n \"data\": {\n \"id\": \"7e067539-6f6c-46e1-8c55-940031b36c6a\",\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 0,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\"\n ],\n \"links\": {\n \"self\": \"/v2/extensions/wishlists/7e067539-6f6c-46e1-8c55-940031b36c6a\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n },\n \"resource_version\\\"\": 0,\n \"data_size\\\"\": 6,\n \"etag_id\\\"\": \"5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "109da719-b139-41d2-a84c-564e7182a074", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a514465c-0edb-457d-9506-847f896cc257", "name": "Forbidden. You do not have permission to access this resource.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"You do not have permission to access this resource.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1d6861c-f368-47dc-ab01-c783403809b0", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b516d1b-5055-4787-a54c-25871bebb31f", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62a7eb21-9f54-4251-9317-4744cdf93db2", "name": "Update a Custom API Entry", "request": { "name": "Update a Custom API Entry", "description": { "content": "Update a Custom API Entry", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" } }, { "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 1,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\",\n \"priority\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c098376e-685d-41a6-98be-05f5dbbe7dfc", "name": "A Custom API Entry", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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 \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 1,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\",\n \"priority\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "A unique identifier representing the current version of the resource. When the resource changes, the ETag value will also change. The ETag hash will be the same value as `etag_id`, and is marked as a weak entity tag string. For example: etag: W/\"5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9\", etag_id: 5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9\n", "type": "text/plain" }, "key": "ETag", "value": "string" } ], "body": "{\n \"data\": {\n \"id\": \"7e067539-6f6c-46e1-8c55-940031b36c6a\",\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 0,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\"\n ],\n \"links\": {\n \"self\": \"/v2/extensions/wishlists/7e067539-6f6c-46e1-8c55-940031b36c6a\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n },\n \"resource_version\\\"\": 0,\n \"data_size\\\"\": 6,\n \"etag_id\\\"\": \"5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a4665cb-641d-470b-9575-d542a47de2ca", "name": "A Custom API Entry", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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 \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 1,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\",\n \"priority\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "A unique identifier representing the current version of the resource. When the resource changes, the ETag value will also change. The ETag hash will be the same value as `etag_id`, and is marked as a weak entity tag string. For example: etag: W/\"5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9\", etag_id: 5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9\n", "type": "text/plain" }, "key": "ETag", "value": "string" } ], "body": "{\n \"data\": {\n \"id\": \"7e067539-6f6c-46e1-8c55-940031b36c6a\",\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 0,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\"\n ],\n \"links\": {\n \"self\": \"/v2/extensions/wishlists/7e067539-6f6c-46e1-8c55-940031b36c6a\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n },\n \"resource_version\\\"\": 0,\n \"data_size\\\"\": 6,\n \"etag_id\\\"\": \"5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcabaa01-bf99-4016-8d40-d083642f9d3b", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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 \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 1,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\",\n \"priority\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "704b078a-a79a-45ec-90be-0012ef8efb54", "name": "Forbidden. You do not have permission to access this resource.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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 \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 1,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\",\n \"priority\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"You do not have permission to access this resource.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97c6a063-0cd8-40a2-b3ae-86592f7039ef", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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 \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 1,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\",\n \"priority\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa059d25-7dae-4a9e-9b25-c0c2b49d2352", "name": "Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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 \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 1,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\",\n \"priority\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"custom_api with the given api_type already exists\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f90930b7-5c28-4cf5-b30e-d536e29a7c36", "name": "Precondition Failed.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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 \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 1,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\",\n \"priority\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Precondition Failed\",\n \"status\": \"412\",\n \"detail\": \"The provided ETag 'W/\\\"4b227777d4dd1fc61c6f884f48641d02b4d121d3fd328cb08b5531fcacdabf8a\\\"', does not match the current ETag 'W/\\\"ef2d127de37b942baad06145e54b0c619a1f22327b2ebbcfbec78f5564afe39d\\\"'.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "270a2219-8d7a-4ac5-bf43-f6fa5702d402", "name": "Payload Too Large.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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 \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 1,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\",\n \"priority\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Request Entity Too Large\",\n \"status\": \"413\",\n \"detail\": \"Maximum entry size reached.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ce2cbcb-a699-4e6c-b456-db28d95ca4ee", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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 \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 1,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\",\n \"priority\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5ad1b71-467f-473a-99dd-e458181c84ea", "name": "The service is temporarily unavailable. This request can be safely retried.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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 \"data\": {\n \"type\": \"wishlist_ext\",\n \"name\": \"My Wishlist\",\n \"items_count\": 1,\n \"keep_purchased\": false,\n \"tags\": [\n \"birthday\",\n \"gifts\",\n \"priority\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"An unknown error occurred\",\n \"status\": \"503\",\n \"title\": \"Service Unavailable\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25a52d6d-fa9d-4011-a083-6353b822553b", "name": "Delete a Custom API Entry", "request": { "name": "Delete a Custom API Entry", "description": { "content": "Delete a Custom API Entry", "type": "text/plain" }, "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" } }, { "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id", "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "896d8adf-c001-4ea2-b10c-86c2a05fd665", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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": "f9b7b0ac-0d0c-47c2-b9a5-4189d941d966", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e205344-76b4-4a08-9aaf-9c3400233346", "name": "Forbidden. You do not have permission to access this resource.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"You do not have permission to access this resource.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9a05f4b-9d70-41d9-932b-9359ad45a8a7", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2541c625-46c8-4087-9c61-367561284dc4", "name": "Precondition Failed.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Precondition Failed\",\n \"status\": \"412\",\n \"detail\": \"The provided ETag 'W/\\\"4b227777d4dd1fc61c6f884f48641d02b4d121d3fd328cb08b5531fcacdabf8a\\\"', does not match the current ETag 'W/\\\"ef2d127de37b942baad06145e54b0c619a1f22327b2ebbcfbec78f5564afe39d\\\"'.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79edd4a1-7376-4e35-85c4-f5c6f2e558df", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f732615-4caf-4477-9439-d4263579823b", "name": "The service is temporarily unavailable. This request can be safely retried.", "originalRequest": { "url": { "path": [ "v2", "settings", "extensions", "custom-apis", ":custom-api-id", "entries", ":custom-api-entry-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-id" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the Custom API Entry.", "type": "text/plain" }, "type": "any", "value": "7e067539-6f6c-46e1-8c55-940031b36c6a", "key": "custom-api-entry-id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) When If-Match is set, the value must be W/\"{etag_id}\". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.\n", "type": "text/plain" }, "key": "If-Match", "value": "string" }, { "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": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"An unknown error occurred\",\n \"status\": \"503\",\n \"title\": \"Service Unavailable\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Personal Data Logs", "description": "When a user’s personal data is changed, an event is logged by Commerce. You can use the Personal Data Logs endpoint to access these logs.\n\nThis API is read only, and you cannot add, update, or delete logs using this API.\n\nThe API only allows you to read all logs for a particular data entry (specified in the filter GET parameter).\n\n:::note\nCurrently, personal data management is only enabled for a limited set of endpoints. See the [personal data concepts page](/docs/api/personal-data/personal-data-introduction) for the list of endpoints that support personal data management.\n:::\n", "item": [ { "id": "c27a0622-85b2-43f8-a13f-777fc1d5c8e8", "name": "Get Personal Data Logs", "request": { "name": "Get Personal Data Logs", "description": { "content": "Gets a list of logs for a specific resource id and resource type.\n\nYou can use pagination with this resource. For more information, see [pagination](/guides/Getting-Started/pagination).\n\n:::note\n* This request is only accessible to `client_credentials` token users with `Seller Admin`, `Support` and `IT` roles.\n* Non `client_credentials` token users cannot access this endpoint. See [Permissions](/docs/authentication/tokens/permissions).\n* This request requires a filter for `resource_type` and `resource_id`.\n :::\n\n## Filtering\n\nThe following operator and attributes are **required** for [filtering](/guides/Getting-Started/filtering) erasure requests.\n\n| Operator | Description |\n|:---------|:-----------------------------------------------------------------------------------------------------|\n| `eq` | Checks whether the values of two operands are equal. If the values are equal, the condition is true. |\n\n| Attribute | Type | Operator | Example |\n| :---------------- | :--- | :--- | :-------------------------------------------------------- |\n| `resource_type` | `string` | `eq` | `eq(resource_type,customer)` |\n| `resource_id` | `string` | `eq` | `eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)` |\n", "type": "text/plain" }, "url": { "path": [ "v2", "personal-data", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2affba62-25a2-467f-bde2-ab423e457140", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "personal-data", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)" } ], "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\": \"faf8c40f-a680-40ae-b7bc-78533bbdd8c3\",\n \"store_id\": \"00000000-0000-1000-8000-000000000000\",\n \"type\": \"personal_data_log_entry\",\n \"initiator\": {\n \"access-token-email\": \"accounts@molt.in\",\n \"access-token-id\": \"1222341536243515939\",\n \"access-token-name\": \"moltin test team\",\n \"access-token-store-id\": \"15ea9633-278c-4807-80f7-2009fed63c7e\",\n \"access-token-type\": \"client-credentials-token\"\n },\n \"time\": \"2022-04-29T10:51:14.374Z\",\n \"event_type\": \"user-authentication-info.event.created\",\n \"delta\": {\n \"email\": \"some@email.com\",\n \"id\": \"00000000-0000-1000-8000-111111111112\",\n \"name\": \"some_name\",\n \"realm_id\": \"00000000-0000-1000-8000-111111111111\",\n \"store_id\": \"00000000-0000-1000-8000-000000000000\",\n \"type\": \"user-authentication-info\"\n },\n \"resource_id\": \"00000000-0000-1000-8000-111111111112\",\n \"resource_type\": \"user-authentication-info\",\n \"relationships\": {\n \"resource_path\": {\n \"url\": \"http://www.elaticpath.com\"\n }\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"limit\": 100,\n \"offset\": 0,\n \"current\": 1,\n \"total\": 1\n },\n \"results\": {\n \"total\": 1\n }\n },\n \"links\": {\n \"current\": \"https://useast.api.elasticpath.com/v2/personal-data/logs?page[offset]=0&page[limit]=20\",\n \"first\": \"https://useast.api.elasticpath.com/v2/personal-data/logs?page[offset]=0&page[limit]=20\",\n \"last\": \"https://useast.api.elasticpath.com/v2/personal-data/logs?page[offset]=0&page[limit]=20\",\n \"next\": \"null\",\n \"prev\": \"null\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de9560f0-481c-40ec-b63b-b66d2f7692bb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "personal-data", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"bad filter: resource_id and resource_type are the filter fields that are both mandatory and only they are allowed\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6bad3fb-1d84-4294-bbc9-25ae7753c0fa", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "personal-data", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)" } ], "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Personal Data Related Data Entries", "description": "This is a supplementary endpoint for the [logs](/docs/api/personal-data/logs-time-to-live-settings) endpoint. It allows you to view all data entries that are related to the\nresource specified in the filter. For example, a user can get all data items that relate to a customer, such as addresses or user authentication info.\n\nThis API is read only, and you cannot add, update, or delete anything using this API.\n\nThe API only allows you to list related data items for a particular data entry (specified in the filter GET parameter).\n", "item": [ { "id": "4a77f392-4819-4bf8-a766-db8ad5f051be", "name": "Get Personal Data Related Data Entries", "request": { "name": "Get Personal Data Related Data Entries", "description": { "content": "Gets a list of related data entries filtered by specific resource id and resource type.\n\nYou can use pagination with this resource. For more information, see [pagination](/guides/Getting-Started/pagination).\n\n:::note\n\n* This request is only accessible to `client_credentials` token users with `Seller Admin`, `Support` and `IT` roles.\n* Non `client_credentials` token users cannot access this endpoint. See [Permissions](/docs/authentication/tokens/permissions).\n* This request requires a filter for `resource_type` and `resource_id`.\n\n:::\n\n## Filtering\n\nThe following operator and attributes are **required** for [filtering](/guides/Getting-Started/filtering) erasure requests.\n\n| Operator | Description |\n|:---------|:-----------------------------------------------------------------------------------------------------|\n| `eq` | Checks whether the values of two operands are equal. If the values are equal, the condition is true. |\n\n| Attribute | Type | Operator | Example |\n| :---------------- | :--- | :--- | :-------------------------------------------------------- |\n| `resource_type` | `string` | `eq` | `eq(resource_type,customer)` |\n| `resource_id` | `string` | `eq` | `eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)` |\n", "type": "text/plain" }, "url": { "path": [ "v2", "personal-data", "related-data-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "15de54b0-801f-48a5-9ab2-b38d61b11354", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "personal-data", "related-data-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)" } ], "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 \"resource_id\": \"00000000-0000-1000-8000-111111111112\",\n \"type\": \"related_data_entry\",\n \"resource_type\": \"user-authentication-info\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"limit\": 20,\n \"offset\": 0,\n \"current\": 1,\n \"total\": 1\n },\n \"results\": {\n \"total\": 1\n }\n },\n \"links\": {\n \"current\": \"https://useast.api.elasticpath.com/v2/personal-data/related-data-entries?page[offset]=0&page[limit]=20\",\n \"first\": \"https://useast.api.elasticpath.com/v2/personal-data/related-data-entries?page[limit]=20&page[offset]=0\",\n \"last\": \"https://useast.api.elasticpath.com/v2/personal-data/related-data-entries?page[offset]=0&page[limit]=20\",\n \"next\": \"null\",\n \"prev\": \"null\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f2206c6-14ad-4174-8503-9a2efe60cdb2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "personal-data", "related-data-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"bad filter: resource_id and resource_type are the filter fields that are both mandatory and only they are allowed\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4b8bdc1-e5ca-44a8-b471-9642cd304518", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "personal-data", "related-data-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)" } ], "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Personal Data Erasure Requests", "description": "Erasure requests enable you to exercise the right, referred to in regulations such as GDPR, as the right to be\nforgotten or right to erase.\nErasure requests allow you to wipe out personal data from Commerce in an automated way, including:\n\n* All related resources (for example, addresses, customers, and so on.)\n* Personal Data Logs\n\nErasure requests can be created for any data entry in the personal data set (see [Personal Data Concept](/docs/api/personal-data/personal-data-introduction) for details), and the result is the same.\n\n:::note\nCurrently, it does not include flows or data external to Commerce.\n:::\n\nErasure requests are processed asynchronously. The POST requests return immediately, and processing continues in\nthe background. You can use the GET endpoint to poll for results until you see `{...\"status\":\"SUCCESS\"...}` in the\nresponse body.\n\nIn the unlikely event an erasure request fails (if the status is not equal to `SUCCESS`), you are advised to retry\nby creating another erasure request. If the problem persists, contact Support.\n\n:::note\nCurrently, personal data management is only enabled for a limited set of endpoints. See\nthe [personal data concepts page](/docs/api/personal-data/personal-data-introduction) for the list of endpoints that support personal data\nmanagement.\n:::\n\nSeller Admin & IT users have full access to Erasure Requests, and Support users have read access.\n", "item": [ { "id": "9012ed69-6352-4303-84f1-a2fa7d60811b", "name": "Create Personal Data Erasure Request", "request": { "name": "Create Personal Data Erasure Request", "description": { "content": "This request serves to create a new erasure request for a given resource ID and Type. All resources that belong to the same personal data set will be erased.\n", "type": "text/plain" }, "url": { "path": [ "v2", "personal-data", "erasure-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"resource_type\": \"account\",\n \"resource_id\": \"98140362-6caf-4829-b93d-953ac6adbe6e\",\n \"type\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0a74cb74-5504-4df1-b5c2-58e057329398", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "personal-data", "erasure-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"resource_type\": \"account\",\n \"resource_id\": \"98140362-6caf-4829-b93d-953ac6adbe6e\",\n \"type\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"fb25ecd9-c610-4659-97d6-0a7550ac0ddc\",\n \"type\": \"erasure_request\",\n \"resource_id\": \"98140362-6caf-4829-b93d-953ac6adbe6e\",\n \"resource_type\": \"account\",\n \"initiator\": {\n \"access-token-email\": \"accounts@molt.in\",\n \"access-token-id\": \"1222341536243515939\",\n \"access-token-name\": \"moltin test team\",\n \"access-token-store-id\": \"15ea9633-278c-4807-80f7-2009fed63c7e\",\n \"access-token-type\": \"client-credentials-token\"\n },\n \"status\": \"CREATED\",\n \"status_description\": \"The erasure request successfully created\",\n \"created_at\": \"2022-06-07T12:25:38.52Z\",\n \"updated_at\": \"2022-06-07T12:25:38.69Z\",\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/personal-data/erasure-requests/fb25ecd9-c610-4659-97d6-0a7550ac0ddc\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e873a37-df3d-4a0e-9b8a-7649a72806c7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "personal-data", "erasure-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"resource_type\": \"account\",\n \"resource_id\": \"98140362-6caf-4829-b93d-953ac6adbe6e\",\n \"type\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Type' on the 'ttl-type' tag.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50093671-b4ef-4c5b-bb14-80a3869ba91a", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "personal-data", "erasure-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"resource_type\": \"account\",\n \"resource_id\": \"98140362-6caf-4829-b93d-953ac6adbe6e\",\n \"type\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9bf54ad-3300-49d7-82b9-1efb2ee1b02a", "name": "Get all Personal Data Erasure Request", "request": { "name": "Get all Personal Data Erasure Request", "description": { "content": "Gets a list of erasure requests for a specific resource id and resource type.\n\nYou can use pagination with this resource. For more information, see [pagination](/guides/Getting-Started/pagination).\n\n## Filtering\n\nThe following operator and attributes are **required** for [filtering](/guides/Getting-Started/filtering)\nerasure requests.\n\n| Operator | Description |\n|:---------|:-----------------------------------------------------------------------------------------------------|\n| `eq` | Checks whether the values of two operands are equal. If the values are equal, the condition is true. |\n\n| Attribute | Type | Operator | Example |\n|:----------------| :--- | :--- |:--------------------------------------------------------|\n| `resource_type` | `string` | `eq` | `eq(resource_type,customer)` |\n| `resource_id` | `string` | `eq` | `eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178\\)` |\n", "type": "text/plain" }, "url": { "path": [ "v2", "personal-data", "erasure-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "11456f2a-8377-4d9e-ac45-6d3a152f5038", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "personal-data", "erasure-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)" } ], "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 \"meta\": {\n \"page\": {\n \"limit\": 10,\n \"offset\": 0,\n \"current\": 1,\n \"total\": 1\n },\n \"results\": {\n \"total\": 1\n }\n },\n \"data\": [\n {\n \"id\": \"43eb23ef-9a97-466f-9315-d0e0c9df25b5\",\n \"type\": \"erasure_request\",\n \"resource_id\": \"abe71c87-974d-4ced-9f83-6b8d5502b0e8\",\n \"resource_type\": \"account\",\n \"initiator\": {\n \"access-token-email\": \"accounts@molt.in\",\n \"access-token-id\": \"1222341536243515939\",\n \"access-token-name\": \"moltin test team\",\n \"access-token-store-id\": \"15ea9633-278c-4807-80f7-2009fed63c7e\",\n \"access-token-type\": \"client-credentials-token\"\n },\n \"status\": \"FAILURE\",\n \"status_description\": \"There was an error processing your request, you can retry it or report it using the id\",\n \"created_at\": \"2022-05-25T10:10:58.623Z\",\n \"updated_at\": \"2022-05-25T10:10:58.676Z\"\n },\n {\n \"id\": \"eeb182ed-f929-4197-bb43-7104afa852f2\",\n \"type\": \"erasure_request\",\n \"resource_id\": \"74f98b7a-dbbf-49ed-b7a7-eaea766b8e38\",\n \"resource_type\": \"address\",\n \"initiator\": {\n \"access-token-email\": \"accounts@molt.in\",\n \"access-token-id\": \"1222341536243515939\",\n \"access-token-name\": \"moltin test team\",\n \"access-token-store-id\": \"15ea9633-278c-4807-80f7-2009fed63c7e\",\n \"access-token-type\": \"client-credentials-token\"\n },\n \"status\": \"SUCCESS\",\n \"status_description\": \"The erasure request is successfully processed\",\n \"created_at\": \"2022-05-26T08:25:37.618Z\",\n \"updated_at\": \"2022-05-26T08:25:37.698Z\"\n },\n {\n \"id\": \"39787c4b-a338-4bd7-ace9-456d1ae8e90b\",\n \"type\": \"erasure_request\",\n \"resource_id\": \"3327fb93-b687-4c0c-a850-ee95e0303ef1\",\n \"resource_type\": \"account\",\n \"initiator\": {\n \"access-token-email\": \"accounts@molt.in\",\n \"access-token-id\": \"1222341536243515939\",\n \"access-token-name\": \"moltin test team\",\n \"access-token-store-id\": \"15ea9633-278c-4807-80f7-2009fed63c7e\",\n \"access-token-type\": \"client-credentials-token\"\n },\n \"status\": \"FAILURE\",\n \"status_description\": \"There was an error processing your request, you can retry it or report it using the id\",\n \"created_at\": \"2022-05-26T08:48:56.183Z\",\n \"updated_at\": \"2022-05-26T08:48:56.365Z\"\n }\n ],\n \"links\": {\n \"current\": \"https://useast.api.elasticpath.com/v2/personal-data/erasure-requests?filter=eq(resource_type,account_member):eq(resource_id,00000000-0000-1000-8000-000f00000300)&page[offset]=0&page[limit]=10\",\n \"first\": \"https://useast.api.elasticpath.com/v2/personal-data/erasure-requests?filter=eq(resource_type,account_member):eq(resource_id,00000000-0000-1000-8000-000f00000300)&page[offset]=0&page[limit]=10\",\n \"last\": \"https://useast.api.elasticpath.com/v2/personal-data/erasure-requests?filter=eq(resource_type,account_member):eq(resource_id,00000000-0000-1000-8000-000f00000300)&page[offset]=0&page[limit]=10\",\n \"next\": \"null\",\n \"prev\": \"null\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc380617-eb6f-44b0-9b29-17c7378843a7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "personal-data", "erasure-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)" } ], "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 \"errors\": [\n {\n \"title\": \"Unauthorized\",\n \"status\": \"401\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "153b4684-5127-4ca6-ad93-d977819fbdd4", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "personal-data", "erasure-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "eq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178)" } ], "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ad15982-a54e-43f4-bf30-a174646b4dfe", "name": "Get Personal Data Erasure Request", "request": { "name": "Get Personal Data Erasure Request", "description": { "content": "This request serves to get an existing erasure request by its ID.\n", "type": "text/plain" }, "url": { "path": [ "v2", "personal-data", "erasure-requests", ":erasure_request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "erasure_request_id", "disabled": false, "description": { "content": "(Required) The id of the Personal-Data Erasure Request.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d2d20af8-6e89-4522-a0e1-08d9ccea2745", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "personal-data", "erasure-requests", ":erasure_request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the Personal-Data Erasure Request.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "erasure_request_id" } ] }, "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 \"id\": \"fb25ecd9-c610-4659-97d6-0a7550ac0ddc\",\n \"type\": \"erasure_request\",\n \"resource_id\": \"98140362-6caf-4829-b93d-953ac6adbe6e\",\n \"resource_type\": \"account\",\n \"initiator\": {\n \"access-token-email\": \"accounts@molt.in\",\n \"access-token-id\": \"1222341536243515939\",\n \"access-token-name\": \"moltin test team\",\n \"access-token-store-id\": \"15ea9633-278c-4807-80f7-2009fed63c7e\",\n \"access-token-type\": \"client-credentials-token\"\n },\n \"status\": \"CREATED\",\n \"status_description\": \"The erasure request successfully created\",\n \"created_at\": \"2022-06-07T12:25:38.52Z\",\n \"updated_at\": \"2022-06-07T12:25:38.69Z\",\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/personal-data/erasure-requests/fb25ecd9-c610-4659-97d6-0a7550ac0ddc\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32906bec-34c5-46c2-a38f-66c26455fb60", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "personal-data", "erasure-requests", ":erasure_request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the Personal-Data Erasure Request.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "erasure_request_id" } ] }, "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 \"errors\": [\n {\n \"detail\": \"not found\",\n \"status\": \"404\",\n \"title\": \"Not Found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d016fb21-e1eb-4391-b6c3-3637f4ef4e1e", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "personal-data", "erasure-requests", ":erasure_request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The id of the Personal-Data Erasure Request.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "erasure_request_id" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Logs Time to Live Settings", "description": "You can use the Logs TTL Settings endpoint to retrieve and update settings controlling logs time-to-live (TTL).\n", "item": [ { "id": "5d1699c1-269d-405c-81c1-6a81e7f9ce2c", "name": "Get Logs Time-to-Live (TTL) Settings", "request": { "name": "Get Logs Time-to-Live (TTL) Settings", "description": {}, "url": { "path": [ "v2", "settings", "logs-ttl" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9f427b34-8aeb-4230-ab0c-6b8045e69422", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "settings", "logs-ttl" ], "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" } ], "body": "{\n \"data\": {\n \"days\": 10,\n \"type\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd56ce1c-6210-440f-ac3b-ce55a346d09c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "settings", "logs-ttl" ], "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 \"errors\": [\n {\n \"title\": \"Unauthorized\",\n \"status\": \"401\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5162e1ae-5ba9-4d3b-9d95-070001b94b1e", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "settings", "logs-ttl" ], "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a809549-76c7-42ca-b69a-91f6590b843c", "name": "Update Logs Time-to-Live (TTL) Settings", "request": { "name": "Update Logs Time-to-Live (TTL) Settings", "description": {}, "url": { "path": [ "v2", "settings", "logs-ttl" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"days\": 10,\n \"type\": \"time_to_live\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c1b0f8dc-4e0f-4605-b878-88e10963be7c", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "settings", "logs-ttl" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"days\": 10,\n \"type\": \"time_to_live\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"days\": 10,\n \"type\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a688bc0-f614-46ca-8e06-165b858ed468", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "settings", "logs-ttl" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"days\": 10,\n \"type\": \"time_to_live\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Type' on the 'ttl-type' tag.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cbc13b9-6cf9-428c-aa75-6f659b829621", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "settings", "logs-ttl" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"data\": {\n \"days\": 10,\n \"type\": \"time_to_live\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Jobs", "description": "\nJobs have the following characteristics:\n\n - Jobs are asynchronous.\n - This process is repeated until all jobs are processed.\n - Jobs have a different status, depending on where a job is in its lifecycle.\n - Jobs are processed one at a time. You can continue to send requests using endpoints that function as jobs, but those jobs are queued. In other words, Commerce looks for any jobs that have a status of PENDING and starts the job with the earliest created date.\n - Jobs include the data used when an endpoint is run.\n - Jobs report messages and/or errors to help you understand the reasons for any failed jobs.\n \n### Job Lifecycle\n \nA job can have the following status:\n\n- PENDING - Commerce has received the request but is currently busy processing other requests.\n- STARTED - Commerce has started processing the job.\n- SUCCESS - The job has successfully completed.\n- FAILED - The job has failed.\n", "item": [ { "id": "fac7297a-1943-4a0b-b680-8e6daaf6f5a3", "name": "Get All Jobs", "request": { "name": "Get All Jobs", "description": { "content": "You can use this endpoint to display the status of your jobs.", "type": "text/plain" }, "url": { "path": [ "v2", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5c454460-3d9e-40de-8055-e48d12c62a8f", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "jobs" ], "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" } ], "body": "{\n \"data\": [\n {\n \"id\": \"974c9db4-38da-4dbf-90c2-33eed5f3e77c\",\n \"type\": \"job\",\n \"job_type\": \"order_export\",\n \"status\": \"failed\",\n \"error\": \"No results matched the supplied filter\",\n \"link\": {\n \"href\": \"\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/jobs/974c9db4-38da-4dbf-90c2-33eed5f3e77c\"\n },\n \"timestamps\": {\n \"created_at\": \"2018-10-04T11:08:49.156490335Z\",\n \"updated_at\": \"2018-10-04T11:08:49.162867081Z\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20c57930-f250-498a-8b1c-c14a2d95cdda", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "jobs" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ac6f427-e14f-465b-9e3c-bdffc36c3e8b", "name": "Create Job", "request": { "name": "Create Job", "description": { "content": "Create a Job to export orders to a CSV file. Jobs automatically expire one week after creation. You must fetch the exported data before the jobs expire.", "type": "text/plain" }, "url": { "path": [ "v2", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"filter\": \"gt(created_at,2018-09-01):lt(created_at,2018-10-01):eq(payment,refunded)\",\n \"job_type\": \"order_export\",\n \"type\": \"job\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4cd83f90-a685-4242-9edc-c434bf554c59", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"filter\": \"gt(created_at,2018-09-01):lt(created_at,2018-10-01):eq(payment,refunded)\",\n \"job_type\": \"order_export\",\n \"type\": \"job\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"974c9db4-38da-4dbf-90c2-33eed5f3e77c\",\n \"type\": \"job\",\n \"job_type\": \"order_export\",\n \"status\": \"failed\",\n \"error\": \"No results matched the supplied filter\",\n \"link\": {\n \"href\": \"\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/jobs/974c9db4-38da-4dbf-90c2-33eed5f3e77c\"\n },\n \"timestamps\": {\n \"created_at\": \"2018-10-04T11:08:49.156490335Z\",\n \"updated_at\": \"2018-10-04T11:08:49.162867081Z\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eec3728-540c-4f83-9d16-7f9e8a0a7110", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"filter\": \"gt(created_at,2018-09-01):lt(created_at,2018-10-01):eq(payment,refunded)\",\n \"job_type\": \"order_export\",\n \"type\": \"job\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2247f720-5663-4609-9bd9-e1cacd34e8db", "name": "Get a Job", "request": { "name": "Get a Job", "description": { "content": "Retrieves the specified job.", "type": "text/plain" }, "url": { "path": [ "v2", "jobs", ":jobID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "jobID", "disabled": false, "description": { "content": "(Required) The unique identifier of the requested job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6bd20d27-da4f-4eb6-bc2f-84a950627ad5", "name": "default", "originalRequest": { "url": { "path": [ "v2", "jobs", ":jobID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the requested job.", "type": "text/plain" }, "type": "any", "value": "string", "key": "jobID" } ] }, "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 \"id\": \"974c9db4-38da-4dbf-90c2-33eed5f3e77c\",\n \"type\": \"job\",\n \"job_type\": \"order_export\",\n \"status\": \"failed\",\n \"error\": \"No results matched the supplied filter\",\n \"link\": {\n \"href\": \"\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/jobs/974c9db4-38da-4dbf-90c2-33eed5f3e77c\"\n },\n \"timestamps\": {\n \"created_at\": \"2018-10-04T11:08:49.156490335Z\",\n \"updated_at\": \"2018-10-04T11:08:49.162867081Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3c6b01b-63b6-490b-881a-996453749bcc", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "jobs", ":jobID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the requested job.", "type": "text/plain" }, "type": "any", "value": "string", "key": "jobID" } ] }, "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 \"title\": \"Resource Not Found\",\n \"status\": 404,\n \"detail\": \"The resource you are requesting does not exist\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d7f2a98-8a25-46f2-900c-b038164ab0fe", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "jobs", ":jobID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the requested job.", "type": "text/plain" }, "type": "any", "value": "string", "key": "jobID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "370f04b8-abf4-4202-bfba-5f32975f69b3", "name": "Get a Job File", "request": { "name": "Get a Job File", "description": { "content": "Retrieves a link to the CSV file that contains your exported order.", "type": "text/plain" }, "url": { "path": [ "v2", "jobs", ":jobID", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "jobID", "disabled": false, "description": { "content": "(Required) The unique identifier of the job whose CSC file you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "de79d733-a761-4099-92d5-8e771be5cc39", "name": "200", "originalRequest": { "url": { "path": [ "v2", "jobs", ":jobID", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the job whose CSC file you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "jobID" } ] }, "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 \"href\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11166afc-ec1e-4605-99aa-5c2e94a9b21d", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "jobs", ":jobID", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the job whose CSC file you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "jobID" } ] }, "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 \"title\": \"Resource Not Found\",\n \"status\": 404,\n \"detail\": \"The resource you are requesting does not exist\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94f96953-8826-4ec4-bd3a-6f7121180f4a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "jobs", ":jobID", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the job whose CSC file you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "string", "key": "jobID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Files", "description": "You can upload image files or URLs by using `multipart/form-data` as the content type header. For example, `\"Content-Type: multipart/form-data\" \\`. Commerce supports the following file types.\n\n| File Extension | Description |\n| --- | --- |\n| .gif | Graphics Interchange Format (GIF) |\n| .jpg/jpeg | Joint Photographic Experts Group (JPEG) format |\n| .png | Portable graphics format |\n| .webp | Web picture format |\n| .mp4 | Moving Picture Experts Group (MPEG) format |\n| .mov | QuickTime Movie format |\n| .pdf | Portable Document Format |\n| .usdz | Universal Scene Description Format |\n| .glb | Global File format |\n| .jp2 | Compressed bitmap image saved in Joint Photographic Experts Group (JPEG) format |\n| .jxr | Extended range for Joint Photographic Experts Group (JPEG) format |\n| .aac | Advanced Audio Coding (AAC) format |\n| .vrml | Virtual Reality Modelling Language (VRML) format |\n| .doc(x) | Microsoft Word Open XML format |\n| .ppt(x) | Microsoft PowerPoint Open XML format |\n| .xls(x) | Microsoft Excel Open XML format |\n\nBy default, the maximum file size is 8MB. If you need to support larger file sizes, contact your Elastic Path representative. Alternatively, store files somewhere else and reference them.\n", "item": [ { "id": "2cec8639-7bdd-43e6-894f-d88e5f9f7d04", "name": "Get all Files", "request": { "name": "Get all Files", "description": { "content": "Retrieves all files.\n\n### Filtering\n\nFor general filtering syntax, see [Filtering](/guides/Getting-Started/filtering).\n\nThe following operators and attributes are available when filtering on this endpoint.\n\n| Attribute | Type | Operators | Example |\n|:----------------------|:----------|:--------------------------|:-------------|\n| `id` | `string` | `in` | `in(id,file-id-1,file-id-2,file-id-3)` |\n| `file_name` | `string` | `eq` / `like` | `eq(file_name, my_image.jpg)` |\n| `width` | `integer` | `gt` / `ge` / `lt` / `le` | `gt(width,200)` |\n| `height` | `integer` | `gt` / `ge` / `lt` / `le` | `lt(height,500)` |\n| `file_size` | `integer` | `gt` / `ge` / `lt` / `le` | `le(file_size,20953)` |\n\n#### Bulk File Retrieval\n\nTo retrieve multiple files by their IDs in a single request, use the `in` operator with a comma-separated list of file IDs:\n\n```\nGET /v2/files?filter=in(id,06b881bd-f152-4c36-8658-7132a8fab49c,ec73567b-04e8-4000-a11a-7e1407cc2f21)\n```\n\nThis is more efficient than making separate requests for each file and is recommended for bulk operations.\n\n**Note on invalid IDs**: If any IDs in the filter are missing, malformed, or do not exist in the store, they will be silently ignored. The response will only include files that were successfully found. For example, if you request 5 IDs but only 3 exist, the response will contain 3 files with `total: 3` in the metadata.\n", "type": "text/plain" }, "url": { "path": [ "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "\nFiltering is available for this endpoint. See [Filtering](/docs/api/pxm/files/get-all-files#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(file_name,00000000-0000-0000-0000-000000000000.png)" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4eddcdfc-e3d6-42bf-8775-1b91ef5a32e4", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "\nFiltering is available for this endpoint. See [Filtering](/docs/api/pxm/files/get-all-files#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(file_name,00000000-0000-0000-0000-000000000000.png)" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "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 \"type\": \"file\",\n \"id\": \"f8cf26b3-6d38-4275-937a-624a83994702\",\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\"\n },\n \"file_name\": \"f6669358-85db-4367-9cde-1deb77acb5f4.png\",\n \"mime_type\": \"image/png\",\n \"file_size\": 110041,\n \"meta\": {\n \"dimensions\": {\n \"width\": 1000,\n \"height\": 1000\n },\n \"timestamps\": {\n \"created_at\": \"2018-03-13T13:45:21.673Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/f8cf26b3-6d38-4275-937a-624a83994702\"\n }\n }\n ],\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files?page[offset]=0&page[limit]=100&filter=\",\n \"first\": \"https://useast.api.elasticpath.com/v2/files?page[offset]=0&page[limit]=100&filter=\",\n \"last\": null\n },\n \"meta\": {\n \"page\": {\n \"limit\": 100,\n \"offset\": 0,\n \"current\": 1,\n \"total\": 1\n },\n \"results\": {\n \"total\": 1\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90ed86a5-5258-4b9b-b4ff-120e5e43a0c5", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "\nFiltering is available for this endpoint. See [Filtering](/docs/api/pxm/files/get-all-files#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(file_name,00000000-0000-0000-0000-000000000000.png)" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "203462ed-b8bd-4a34-b163-4e246176be54", "name": "Create a File", "request": { "name": "Create a File", "description": { "content": "Create a File", "type": "text/plain" }, "url": { "path": [ "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Indicates the file you want to upload.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Use this parameter to reference a file stored at a specific location. This must be the URL that points to an image file.", "type": "text/plain" }, "key": "file_location", "value": "@/path/to/file.jpg", "type": "text" } ] }, "auth": null }, "response": [ { "id": "6257e726-189d-4047-ab46-e4c48e483519", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "Indicates the file you want to upload.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Use this parameter to reference a file stored at a specific location. This must be the URL that points to an image file.", "type": "text/plain" }, "key": "file_location", "value": "@/path/to/file.jpg", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"file\",\n \"id\": \"f8cf26b3-6d38-4275-937a-624a83994702\",\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\"\n },\n \"file_name\": \"f6669358-85db-4367-9cde-1deb77acb5f4.png\",\n \"mime_type\": \"image/png\",\n \"file_size\": 110041,\n \"meta\": {\n \"dimensions\": {\n \"width\": 1000,\n \"height\": 1000\n },\n \"timestamps\": {\n \"created_at\": \"2018-03-13T13:45:21.673Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/f8cf26b3-6d38-4275-937a-624a83994702\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "321514fd-64ae-4567-a6ab-de2223c4502b", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "Indicates the file you want to upload.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Use this parameter to reference a file stored at a specific location. This must be the URL that points to an image file.", "type": "text/plain" }, "key": "file_location", "value": "@/path/to/file.jpg", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"file_location invalid\",\n \"status\": 422,\n \"detail\": \"@/path/to/file.jpg is not a valid URL\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f1af294-e3c3-43a7-aeae-fd08e0b87225", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "Indicates the file you want to upload.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Use this parameter to reference a file stored at a specific location. This must be the URL that points to an image file.", "type": "text/plain" }, "key": "file_location", "value": "@/path/to/file.jpg", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"file_location invalid\",\n \"status\": 422,\n \"detail\": \"@/path/to/file.jpg is not a valid URL\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "385cbff0-72cf-4c01-b060-a0a28c8df269", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "Indicates the file you want to upload.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Use this parameter to reference a file stored at a specific location. This must be the URL that points to an image file.", "type": "text/plain" }, "key": "file_location", "value": "@/path/to/file.jpg", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03978f61-360f-48c3-afce-cf5edb81360b", "name": "Get a File", "request": { "name": "Get a File", "description": { "content": "Get a File", "type": "text/plain" }, "url": { "path": [ "v2", "files", ":fileID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "fileID", "disabled": false, "description": { "content": "(Required) The unique identifier for a file.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8df15c94-2f6f-4b64-a7cf-30677f7685e3", "name": "default", "originalRequest": { "url": { "path": [ "v2", "files", ":fileID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier for a file.", "type": "text/plain" }, "type": "any", "value": "string", "key": "fileID" } ] }, "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 \"type\": \"file\",\n \"id\": \"f8cf26b3-6d38-4275-937a-624a83994702\",\n \"link\": {\n \"href\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png\"\n },\n \"file_name\": \"f6669358-85db-4367-9cde-1deb77acb5f4.png\",\n \"mime_type\": \"image/png\",\n \"file_size\": 110041,\n \"meta\": {\n \"dimensions\": {\n \"width\": 1000,\n \"height\": 1000\n },\n \"timestamps\": {\n \"created_at\": \"2018-03-13T13:45:21.673Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/files/f8cf26b3-6d38-4275-937a-624a83994702\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edd512b1-525d-4798-b0aa-2ed846076541", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "files", ":fileID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier for a file.", "type": "text/plain" }, "type": "any", "value": "string", "key": "fileID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Resource Not Found\",\n \"status\": 404,\n \"detail\": \"The resource you are requesting does not exist\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3cb544d-d27b-46f1-8a44-0158495af5d5", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "files", ":fileID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier for a file.", "type": "text/plain" }, "type": "any", "value": "string", "key": "fileID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ab9ae6f-00d2-4328-85d1-6d7c36b3a116", "name": "Delete a File", "request": { "name": "Delete a File", "description": { "content": "Delete a File", "type": "text/plain" }, "url": { "path": [ "v2", "files", ":fileID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "fileID", "disabled": false, "description": { "content": "(Required) The unique identifier of the file you want to delete.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "9dcb8e73-523d-405c-90e3-800e6bc4b2d9", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "files", ":fileID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the file you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "fileID" } ] }, "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": "6796b8a5-8810-4770-99f0-dec5d6d1f985", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "files", ":fileID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the file you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "fileID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": 403,\n \"detail\": \"You are trying to remove a file outside of the tenancy\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79837667-1147-4728-a281-493697828dce", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "files", ":fileID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the file you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "fileID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Resource Not Found\",\n \"status\": 404,\n \"detail\": \"The resource you are requesting does not exist\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e7b8052-2f35-44d6-87c2-3970c0ef2cb7", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "files", ":fileID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the file you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "fileID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Flows", "description": "\n### Flows in Commerce\n\nThere are two scenarios for using flows:\n\n- Extend an existing resource, such as customers and orders.\n- Create a new resource, such as a blog, wishlist, or customer review.\n\n#### Extend an existing resource\n\nThe most common usage of the Flows API is to extend existing resources, such as `customers` and `orders`. These types of resources are called core flows and are handled differently than non-core flows. See [**Core and non-core flows**](#core-and-non-core-flows).\n\nFor example, you can extend the `customer` resource to store custom data, such as a `user_profile` field for customers. Or you might want to add an `age` field to store a customer's age.\n\nExtending a resource applies only to core flows. When creating a new flow, make sure the `slug` matches that of a core resource listed in the following table.\n\n| Flow slug | Description | Availability Level |\n|:--------------------------------------------|:-------------------------------| :---|\n| `accounts` | Extend the [`account`](/docs/api/accounts/account-management-introduction) object. | Store |\n| `account-members` | Extend the [`account-members`](/docs/api/accounts/account-members) object. | Store |\n| `account-memberships` | Extend the [`account-membership`](/docs/api/accounts/account-membership) object. | Store |\n| `addresses` | Extend the [`address`](/docs/api/addresses/account-addresses) object. | Store |\n| `authentication-realms` | Extend the [`authentication-realms`](/docs/api/single-sign-on/authentication-realms) object. | Store |\n| `carts` | Extend the [`carts`](/docs/api/carts/carts-checkout-orders-introduction) object. | Organization/Store |\n| `cart_items` | Extend the [`cart_item`](/docs/api/carts/cart-items) object. | Organization/Store |\n| `customers` | Extend the [`customer`](/docs/customer-management/customer-management-api/customer-management-api-overview) object. **Note**: Please use Account Management for all new frontend experiences. | n/a |\n| `oidc-profiles` | Extend the [`oidc-profiles`](/docs/api/single-sign-on/oidc-profiles) object. | Store |\n| `order_items` | Extend the [`order_item`](/docs/api/carts/get-order-items) object. | Organization/Store |\n| `orders` | Extend the [`order`](/docs/api/carts/orders) object. | Organization/Store |\n| `password-profiles` | Extend the [`password-profiles`](/docs/api/single-sign-on/password-profiles) object. | Store |\n| `products` | Extend the [`product`](/docs/api/pxm/products/products) object. | Store |\n| `promotions` | Extend the [`promotion`](/docs/api/promotions/promotions-standard-introduction) object. | Store |\n| `rule-promotions` | Extend the [`rule-promotion`](/docs/api/promotions-builder/create-rule-promotion) object. | Store |\n| `user-authentication-info` | Extend the [`user-authentication-info`](/docs/api/single-sign-on/user-authentication-infos) object. | Store |\n| `user-authentication-oidc-profile-info` | Extend the [`user-authentication-oidc-profile-info`](/docs/api/single-sign-on/user-authentication-oidc-profile-infos) object. | Store |\n| `user-authentication-password-profile-info` | Extend the [`user-authentication-password-profile-info`](/docs/api/single-sign-on/user-authentication-password-profile-infos) object. | Store |\n| `catalogs` | Extend the [`catalog`](/docs/api/pxm/catalog/catalogs) object. It will not extend the [`catalog-release`](/docs/api/pxm/catalog/releases) object. | Store |\n\n#### Create a new resource\n\nYou can create new resources to support product reviews, wish lists, blog articles, staff profile pages, and many more. These non-core flows are referred to as custom flows. See [**Core and non-core flows**](#core-and-non-core-flows).\n\n:::note\n\n[Custom APIs](/docs/api/commerce-extensions/custom-ap-is#custom-apis-vs-non-core-flows) are the next generation of Non-Core Flows. Flows are not going anywhere, but Custom APIs offer enhanced capabilities. We recommend using Custom APIs for any of your new use cases.\n\n:::\n\n#### Core and non-core flows\n\nThe following table describes the differences between core and non-core flows:\n\n| Core Flows | Non-core Flows |\n|:--------------------------------------------------------------|:-------------|\n| Extend an existing resource. | Create a new resource. |\n| Entries managed automatically by Commerce. | Create and manage entries manually. |\n| Requests are sent to the `fields` endpoint. | Requests are sent to the `entries` endpoint. |\n\n:::caution\n\nYou cannot delete core flows after creating them with the API or Commerce Manager.\n\n:::\n\n#### Flows taxonomy\n\nFields and entries are an integral part of flows. A flow describes a collection of fields. A field represents a single field of data. An entry is a specific instance of a flow, and is associated with a specific instance of an entity, such as a single customer. Entries for core flows (existing resources) are managed automatically for you.\n\nIn database terms, you can think of flows as tables, fields as columns, and entries as database records.\n\n### Templates in Product Experience Manager\n\nTemplates allow you to attach a specific set of attributes to your products.\n\n- You can use templates to define characteristics of your products.\n- You can use templates for Search Engine Optimization (SEO).\n\n#### Template Taxonomy\n\nAttributes and entries are integral to templates. A template describes a collection of attributes. An attribute represents a single characteristic, like color. An entry is a specific instance of an attribute, for example, blue, and is associated with a specific product.\n\n A template is exactly the same as a flow except it has a different naming convention. The name of a template is in the format **products(*slug*)** where *slug* is the slug of a template.\n\n#### Associating templates with products\n\n Once you have created your template, and [**associated**](/docs/api/flows/create-an-entry-relationship) the temp with a product in Product Experience Manager, it becomes a template. \n\n For example, if you create a template with a slug of `SizeGuide` then the template name is **products(SizeGuide)**. You can then [**associate**](/docs/api/flows/create-an-entry-relationship) this template to all clothing products in your store and the slug is included in all the responses that contain products.\n\n You can create product templates for both organization and store. In addition, stores can use organization templates for store-level products.\n\n For more information about adding attributes, see [**Fields**](/docs/api/flows/fields).\n", "item": [ { "id": "5d2a10ac-ff14-4ed6-aecc-616836e5e37c", "name": "Get all Flows", "request": { "name": "Get all Flows", "description": { "content": "- For Commerce, this endpoint retrieves a list of flows.\n- For Product Experience Manager, this endpoint retrieves a list of templates.\n", "type": "text/plain" }, "url": { "path": [ "v2", "flows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c0371689-491a-4adc-89a6-02909a712670", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "flows" ], "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" } ], "body": "{\n \"data\": [\n {\n \"id\": \"6d320b42-237d-4474-8452-d49f884d4ae1\",\n \"type\": \"flow\",\n \"name\": \"Products-1\",\n \"slug\": \"products-1\",\n \"description\": \"Extends the default product object\",\n \"enabled\": true,\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/flows/6d320b42-237d-4474-8452-d49f884d4ae1\"\n },\n \"relationships\": {},\n \"meta\": {\n \"owner\": \"organization\",\n \"timestamps\": {\n \"created_at\": \"2018-05-10T18:04:26.623Z\",\n \"updated_at\": \"2018-05-10T18:04:26.623Z\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c665442-b22b-422c-b2e0-edabf56f2530", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "flows" ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13ea3aee-7ebf-48d6-8cf6-890bd4b1af70", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "786fc2a6-28fd-4ab1-9618-44a3c9c0036d", "name": "Create a Flow", "request": { "name": "Create a Flow", "description": { "content": "- For Commerce, this endpoint creates a flow.\n- For Product Experience Manager, this endpoint creates a template.\n\n:::caution\n\nCustom names and values prefixed with $ are not supported.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "flows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"description\": \"Extends the default product object\",\n \"enabled\": true,\n \"name\": \"Products\",\n \"slug\": \"products\",\n \"type\": \"flow\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b6d30773-6dde-4b13-81f2-9e6f6dc0e31b", "name": "default", "originalRequest": { "url": { "path": [ "v2", "flows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"description\": \"Extends the default product object\",\n \"enabled\": true,\n \"name\": \"Products\",\n \"slug\": \"products\",\n \"type\": \"flow\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"6d320b42-237d-4474-8452-d49f884d4ae1\",\n \"type\": \"flow\",\n \"name\": \"Products-1\",\n \"slug\": \"products-1\",\n \"description\": \"Extends the default product object\",\n \"enabled\": true,\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/flows/6d320b42-237d-4474-8452-d49f884d4ae1\"\n },\n \"relationships\": {},\n \"meta\": {\n \"owner\": \"organization\",\n \"timestamps\": {\n \"created_at\": \"2018-05-10T18:04:26.623Z\",\n \"updated_at\": \"2018-05-10T18:04:26.623Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "632a28a9-c810-4d82-9187-44a07fdac152", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "flows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"description\": \"Extends the default product object\",\n \"enabled\": true,\n \"name\": \"Products\",\n \"slug\": \"products\",\n \"type\": \"flow\"\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 \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1605a56-0d69-4bc4-801e-f47cb26320b9", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"description\": \"Extends the default product object\",\n \"enabled\": true,\n \"name\": \"Products\",\n \"slug\": \"products\",\n \"type\": \"flow\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cdda3628-d9fa-4b33-8182-2294fad0533a", "name": "Get a Flow", "request": { "name": "Get a Flow", "description": { "content": "- For Commerce, this endpoint retrieves a flow.\n- For Product Experience Manager, this endpoint retrieves a template.\n", "type": "text/plain" }, "url": { "path": [ "v2", "flows", ":flowID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowID", "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "884968cb-faa8-4ed0-85c7-c74eb0049906", "name": "default", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowID" } ] }, "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 \"id\": \"38ba1451-efa4-4361-9ca6-3fb646490f37\",\n \"type\": \"flow\",\n \"name\": \"extraFieldRenamed\",\n \"slug\": \"products\",\n \"description\": \"Extends the default product object\",\n \"enabled\": true,\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/flows/38ba1451-efa4-4361-9ca6-3fb646490f37\"\n },\n \"relationships\": {},\n \"meta\": {\n \"owner\": \"organization\",\n \"timestamps\": {\n \"created_at\": \"2018-05-10T01:41:36.009Z\",\n \"updated_at\": \"2018-05-10T15:27:26.241Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b300603b-08f1-4b9a-bd98-ae8e5b801374", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfc0d955-2525-41f2-bd85-a7bcab75e8cb", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6fa080e2-03c7-4294-a9d8-fec11c77712b", "name": "Delete a Flow", "request": { "name": "Delete a Flow", "description": { "content": "- For Commerce, this endpoint deletes a flow. We recommend that you remove all the fields assigned to a flow before deleting a flow.\n- For Product Experience Manager, this endpoint deletes a template. We recommend that you remove all the attributes assigned to a template before deleting a template.\n", "type": "text/plain" }, "url": { "path": [ "v2", "flows", ":flowID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowID", "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template you want to delete.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "a520505c-fb76-430d-93c8-aed362b4c392", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template you want to delete.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowID" } ] }, "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": "a343b9fb-a083-4ff1-a099-522e683109ae", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template you want to delete.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d002bbe-43ab-42f1-b3bf-f079e12ec6d9", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template you want to delete.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1bb28ba9-2730-4856-a315-4f9cb969622e", "name": "Update a Flow", "request": { "name": "Update a Flow", "description": { "content": "- For Commerce, this endpoint updates a flow. \n- For Product Experience Manager, this endpoint updates a template. \n\n Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the flow/template is not updated.\n", "type": "text/plain" }, "url": { "path": [ "v2", "flows", ":flowID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowID", "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template you want to update.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"25617d3e-14a6-434c-bfab-3fda87517aaf\",\n \"description\": \"Extends the default product object\",\n \"enabled\": true,\n \"name\": \"Products\",\n \"slug\": \"products\",\n \"type\": \"flow\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7fab7501-3565-49d5-b179-803f3ebe58fd", "name": "default", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template you want to update.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowID" } ] }, "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 \"data\": {\n \"id\": \"25617d3e-14a6-434c-bfab-3fda87517aaf\",\n \"description\": \"Extends the default product object\",\n \"enabled\": true,\n \"name\": \"Products\",\n \"slug\": \"products\",\n \"type\": \"flow\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"6d320b42-237d-4474-8452-d49f884d4ae1\",\n \"type\": \"flow\",\n \"name\": \"extraFieldRenamed\",\n \"slug\": \"products-1\",\n \"description\": \"Extends the default product object\",\n \"enabled\": true,\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/flows/6d320b42-237d-4474-8452-d49f884d4ae1\"\n },\n \"relationships\": {},\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2018-05-10T18:04:26.623Z\",\n \"updated_at\": \"2018-05-10T18:11:47.469Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57a48e24-7983-4524-ab62-04066d7d9d2b", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template you want to update.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowID" } ] }, "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 \"data\": {\n \"id\": \"25617d3e-14a6-434c-bfab-3fda87517aaf\",\n \"description\": \"Extends the default product object\",\n \"enabled\": true,\n \"name\": \"Products\",\n \"slug\": \"products\",\n \"type\": \"flow\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de35117b-042c-456b-90d4-a0c0b0130dfa", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template you want to update.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowID" } ] }, "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 \"data\": {\n \"id\": \"25617d3e-14a6-434c-bfab-3fda87517aaf\",\n \"description\": \"Extends the default product object\",\n \"enabled\": true,\n \"name\": \"Products\",\n \"slug\": \"products\",\n \"type\": \"flow\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Fields", "description": "With fields, you can:\n\n- in Commerce, use a field in your flows to represent single field of data (for example a `Product Rating`) to be applied to an entity\n- in Product Experience Manager, use an attribute in your template to attach a characteristic like `color` to a product.\n\nA field/attribute represents a single piece of data. All fields/attributes have a `field_type` (`string`, `integer`, `boolean`, `date` or `relationship`), a default value, and an optional set of validation rules.\n\n:::caution\n\n- Custom names and values prefixed with `$` are not supported.\n- There is a hard limit of 100 fields per flow.\n- You can configure default values for fields. If you choose to do so, you must ensure that your default field values comply with your validation rules.\n\n:::\n\n#### Field/Attribute Validation Rules\n\nWhen creating a field/attribute, you can add validation to the values that are stored. The validation you use depends on the `field_type` of the field/attribute. Each validation rule is expressed as a validation rule object.\n\n#### `string` / `enum`\n\nMust be one of a predefined collection of strings. If you leave the field blank or enter an incorrect value then an `Invalid Value` error is displayed. \n\n| Attribute | Type | Description |\n| :--- | :--- | :--- |\n| `type` | `string` | `enum` |\n| `options` | `array[string]` | An array of valid string values. |\n\n##### `string` / `email`\n\nMust be a valid email address.\n\n| Attribute | Type | Description |\n| :--- | :--- | :--- |\n| `type` | `string` | `email` |\n\n##### `string` / `slug`\n\nCan contain only letters, numbers, hyphens and underscores.\n\n| Attribute | Type | Description |\n| :--- | :--- | :--- |\n| `type` | `string` | `slug` |\n\n##### `integer` / `between`\n\nMust be between the two provided values.\n\n| Attribute | Type | Description |\n| :--- | :--- | :--- |\n| `type` | `string` | `enum` |\n| `options` | `object` | An object containing `from` and `to` integers. |\n\n##### `integer` / `enum`\n\nMust be one of a predefined collection of integers.\n\n| Attribute | Type | Description |\n| :--- | :--- | :--- |\n| `type` | `string` | `enum` |\n| `options` | `array[integer]` | An array of valid integer values. |\n\n##### `float` / `between`\n\nMust be between the two provided values.\n\n| Attribute | Type | Description |\n| :--- | :--- | :--- |\n| `type` | `string` | `enum` |\n| `options` | `object` | An object containing `from` and `to` floats. |\n\n##### `float` / `enum`\n\nMust be one of a predefined collection of floats.\n\n| Attribute | Type | Description |\n| :--- | :--- | :--- |\n| `type` | `string` | `enum` |\n| `options` | `array[float]` | An array of valid float values. |\n\n#### `date` / `enum`\n\nMust be one of a predefined collection of dates.\n\n| Attribute | Type | Description |\n| :--- | :--- | :--- |\n| `type` | `string` | `enum` |\n| `options` | `array[string]` | An array of valid date values as strings \\(`YYYY-MM-DD HH:MM:SS` - time is optional\\). |\n\n##### `relationship` / `one-to-many`\n\n:::caution\nThis only applies to Commerce. You cannot use relationships in Product Experience Manager templates.\n:::\n\nAllows multiple relationships to be created.\n\n| Attribute | Type | Description |\n| :--- | :--- | :--- |\n| `type` | `string` | `one-to-many` |\n| `to` | `string` | The entity type you are making relationships with in singular form (for example, `product`). |\n\n##### `relationship` / `one-to-one`\n\n:::caution\nThis only applies to Commerce. You cannot use relationships in Product Experience Manager templates.\n:::\n\nAllows only a single relationships to be created on an entry.\n\n| Attribute | Type | Description |\n| :--- | :--- | :--- |\n| `type` | `string` | `one-to-one` |\n| `to` | `string` | The entity type you are making relationships with in singular form (for example, `customer`). |\n", "item": [ { "id": "816fef19-1d3d-40b2-8c40-4227ae6f4021", "name": "Get all Fields", "request": { "name": "Get all Fields", "description": { "content": "- For Commerce, this endpoint retrieves all fields in a flow. \n- For Product Experience Manager, this endpoint retrieves all attributes in a template.\n", "type": "text/plain" }, "url": { "path": [ "v2", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b1f0f63c-a39d-43ed-96b1-e7e8f4f74cb5", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "fields" ], "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" } ], "body": "{\n \"data\": [\n {\n \"id\": \"e88d03d3-d46e-40d0-8302-25e6b5b1bd33\",\n \"type\": \"field\",\n \"field_type\": \"boolean\",\n \"slug\": \"on_sale\",\n \"name\": \"On Sale?\",\n \"description\": \"Is this on sale?\",\n \"required\": false,\n \"default\": null,\n \"enabled\": true,\n \"order\": null,\n \"omit_null\": false,\n \"validation_rules\": [],\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/flows/9d69c6cf-aaee-4dc6-8908-d2bd053446a2/fields/e88d03d3-d46e-40d0-8302-25e6b5b1bd33\"\n },\n \"relationships\": {\n \"flow\": {\n \"data\": {\n \"id\": \"9d69c6cf-aaee-4dc6-8908-d2bd053446a2\",\n \"type\": \"flow\"\n }\n }\n },\n \"meta\": {\n \"owner\": \"organization\",\n \"timestamps\": {\n \"created_at\": \"2018-08-23T10:28:43.609Z\",\n \"updated_at\": \"2018-08-23T10:28:43.609Z\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8730dbff-0512-4655-b09b-757242a6cdc1", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "fields" ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8def95c-7086-4e4b-9322-3437cf318235", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "fields" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9c5ef90-dca9-40d6-995e-3a734cbbbb1a", "name": "Create a Field", "request": { "name": "Create a Field", "description": { "content": "- For Commerce, this endpoint creates a field.\n- For Product Experience Manager, this endpoint creates an attribute.\n", "type": "text/plain" }, "url": { "path": [ "v2", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"default\": 4,\n \"description\": \"Average rating as given by our users\",\n \"enabled\": true,\n \"field_type\": \"integer\",\n \"name\": \"Product Rating\",\n \"order\": 1,\n \"relationships\": {\n \"flow\": {\n \"data\": {\n \"id\": \"{{flowID}}\",\n \"type\": \"flow\"\n }\n }\n },\n \"required\": false,\n \"slug\": \"product-rating\",\n \"type\": \"field\",\n \"validation_rules\": [\n {\n \"options\": {\n \"from\": 1,\n \"to\": 5\n },\n \"type\": \"between\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f23e994e-b6de-437a-bd9b-1afd56234e81", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"default\": 4,\n \"description\": \"Average rating as given by our users\",\n \"enabled\": true,\n \"field_type\": \"integer\",\n \"name\": \"Product Rating\",\n \"order\": 1,\n \"relationships\": {\n \"flow\": {\n \"data\": {\n \"id\": \"{{flowID}}\",\n \"type\": \"flow\"\n }\n }\n },\n \"required\": false,\n \"slug\": \"product-rating\",\n \"type\": \"field\",\n \"validation_rules\": [\n {\n \"options\": {\n \"from\": 1,\n \"to\": 5\n },\n \"type\": \"between\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"field\",\n \"name\": \"Product Rating\",\n \"slug\": \"product-rating\",\n \"field_type\": \"integer\",\n \"validation_rules\": [\n {\n \"type\": \"between\",\n \"options\": {\n \"from\": 1,\n \"to\": 5\n }\n }\n ],\n \"description\": \"Average rating as given by our users\",\n \"required\": false,\n \"default\": 0,\n \"enabled\": true,\n \"order\": 1,\n \"omit_null\": false,\n \"relationships\": {\n \"flow\": {\n \"data\": {\n \"type\": \"flow\",\n \"id\": \"e4145c27-aba1-46af-81a3-58f5e1cf7f15\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8b7011b-0b0e-43d7-b2ec-bf011540e138", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"default\": 4,\n \"description\": \"Average rating as given by our users\",\n \"enabled\": true,\n \"field_type\": \"integer\",\n \"name\": \"Product Rating\",\n \"order\": 1,\n \"relationships\": {\n \"flow\": {\n \"data\": {\n \"id\": \"{{flowID}}\",\n \"type\": \"flow\"\n }\n }\n },\n \"required\": false,\n \"slug\": \"product-rating\",\n \"type\": \"field\",\n \"validation_rules\": [\n {\n \"options\": {\n \"from\": 1,\n \"to\": 5\n },\n \"type\": \"between\"\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 \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7be3ae70-c92a-4cf1-8e39-b3b52d62666e", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"default\": 4,\n \"description\": \"Average rating as given by our users\",\n \"enabled\": true,\n \"field_type\": \"integer\",\n \"name\": \"Product Rating\",\n \"order\": 1,\n \"relationships\": {\n \"flow\": {\n \"data\": {\n \"id\": \"{{flowID}}\",\n \"type\": \"flow\"\n }\n }\n },\n \"required\": false,\n \"slug\": \"product-rating\",\n \"type\": \"field\",\n \"validation_rules\": [\n {\n \"options\": {\n \"from\": 1,\n \"to\": 5\n },\n \"type\": \"between\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58c22b19-e697-4aea-ae44-b108f57550fd", "name": "Get a Field", "request": { "name": "Get a Field", "description": { "content": "- For Commerce, this endpoint retrieves a field.\n- For Product Experience Manager, this endpoint retrieves an attribute.\n", "type": "text/plain" }, "url": { "path": [ "v2", "fields", ":flowFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowFieldID", "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template whose field/attribute you want to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "03cfd6d4-df5c-4eb7-a3db-74aab0f64cbc", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "fields", ":flowFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template whose field/attribute you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowFieldID" } ] }, "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 \"id\": \"102b2087-d56a-45e7-bf1c-e9517716abb3\",\n \"type\": \"field\",\n \"field_type\": \"integer\",\n \"slug\": \"product-rating\",\n \"name\": \"Product Rating\",\n \"description\": \"Average rating as given by our users\",\n \"required\": false,\n \"default\": null,\n \"enabled\": true,\n \"validation_rules\": [\n {\n \"type\": \"between\",\n \"options\": {\n \"from\": 1,\n \"to\": 5\n }\n }\n ],\n \"order\": 1,\n \"omit_null\": false,\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/flows/6d320b42-237d-4474-8452-d49f884d4ae1/fields/102b2087-d56a-45e7-bf1c-e9517716abb3\"\n },\n \"relationships\": {\n \"flow\": {\n \"data\": {\n \"id\": \"6d320b42-237d-4474-8452-d49f884d4ae1\",\n \"type\": \"flow\"\n }\n }\n },\n \"meta\": {\n \"owner\": \"organization\",\n \"timestamps\": {\n \"created_at\": \"2018-05-10T18:19:11.559Z\",\n \"updated_at\": \"2018-05-10T18:19:11.559Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bc2b264-7b1c-4116-b211-a6a1cb8be07b", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "fields", ":flowFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template whose field/attribute you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowFieldID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2baeee8f-7ed8-4089-849a-31aeeca7eadc", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "fields", ":flowFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the flow/template whose field/attribute you want to retrieve.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowFieldID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d46d9ad3-e5d2-4e64-a667-763628e64497", "name": "Update a Field", "request": { "name": "Update a Field", "description": { "content": "- For Commerce, this endpoint updates a field.\n- For Product Experience Manager, this endpoint updates an attribute.\n\nSpecify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the field/attribute is not updated.\n", "type": "text/plain" }, "url": { "path": [ "v2", "fields", ":flowFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowFieldID", "disabled": false, "description": { "content": "(Required) The unique identifier for the flow/template to which the field/attribute you want to update belongs.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"default\": 1,\n \"description\": \"Average rating as given by our users\",\n \"field_type\": \"integer\",\n \"id\": \"{{flowFieldID}}\",\n \"name\": \"Product Rating\",\n \"required\": true,\n \"enabled\": true,\n \"slug\": \"product-rating\",\n \"type\": \"field\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "47da34b9-dd9a-45ab-8cce-649d21669c06", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "fields", ":flowFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier for the flow/template to which the field/attribute you want to update belongs.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowFieldID" } ] }, "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 \"data\": {\n \"default\": 1,\n \"description\": \"Average rating as given by our users\",\n \"field_type\": \"integer\",\n \"id\": \"{{flowFieldID}}\",\n \"name\": \"Product Rating\",\n \"required\": true,\n \"enabled\": true,\n \"slug\": \"product-rating\",\n \"type\": \"field\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"102b2087-d56a-45e7-bf1c-e9517716abb3\",\n \"type\": \"field\",\n \"field_type\": \"integer\",\n \"slug\": \"start-of-life\",\n \"name\": \"start-of-life\",\n \"description\": \"day the iphone will work\",\n \"required\": true,\n \"default\": \"2018-01-01\",\n \"enabled\": true,\n \"validation_rules\": [\n {\n \"type\": \"between\",\n \"options\": {\n \"from\": 1,\n \"to\": 5\n }\n }\n ],\n \"order\": 1,\n \"omit_null\": false,\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/flows/6d320b42-237d-4474-8452-d49f884d4ae1/fields/102b2087-d56a-45e7-bf1c-e9517716abb3\"\n },\n \"relationships\": {\n \"flow\": {\n \"data\": {\n \"id\": \"6d320b42-237d-4474-8452-d49f884d4ae1\",\n \"type\": \"flow\"\n }\n }\n },\n \"meta\": {\n \"owner\": \"organization\",\n \"timestamps\": {\n \"created_at\": \"2018-05-10T18:19:11.559Z\",\n \"updated_at\": \"2018-05-10T18:36:01.208Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faf29239-81fe-4803-98ce-6eddce6bebcb", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "fields", ":flowFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier for the flow/template to which the field/attribute you want to update belongs.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowFieldID" } ] }, "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 \"data\": {\n \"default\": 1,\n \"description\": \"Average rating as given by our users\",\n \"field_type\": \"integer\",\n \"id\": \"{{flowFieldID}}\",\n \"name\": \"Product Rating\",\n \"required\": true,\n \"enabled\": true,\n \"slug\": \"product-rating\",\n \"type\": \"field\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "531545a9-ad85-4c0b-80de-95d27dc3d447", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "fields", ":flowFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier for the flow/template to which the field/attribute you want to update belongs.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowFieldID" } ] }, "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 \"data\": {\n \"default\": 1,\n \"description\": \"Average rating as given by our users\",\n \"field_type\": \"integer\",\n \"id\": \"{{flowFieldID}}\",\n \"name\": \"Product Rating\",\n \"required\": true,\n \"enabled\": true,\n \"slug\": \"product-rating\",\n \"type\": \"field\"\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 \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5362f79-4621-491a-9101-ca13763246ee", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "fields", ":flowFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier for the flow/template to which the field/attribute you want to update belongs.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "flowFieldID" } ] }, "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 \"data\": {\n \"default\": 1,\n \"description\": \"Average rating as given by our users\",\n \"field_type\": \"integer\",\n \"id\": \"{{flowFieldID}}\",\n \"name\": \"Product Rating\",\n \"required\": true,\n \"enabled\": true,\n \"slug\": \"product-rating\",\n \"type\": \"field\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff96e33b-2bb7-410b-b00d-538592c59bb4", "name": "Delete a Field", "request": { "name": "Delete a Field", "description": { "content": "- For Commerce, this endpoint deletes a field.\n- For Product Experience Manager, this endpoint deletes an attribute.\n", "type": "text/plain" }, "url": { "path": [ "v2", "fields", ":flowFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "flowFieldID", "disabled": false, "description": { "content": "(Required) The unique identifier of the field/attribute that you want to delete.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "681a9194-7e2b-4a00-b28f-0b447d4572c5", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "fields", ":flowFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the field/attribute that you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldID" } ] }, "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": "b0e4b253-8935-4d00-ad6b-a1a880df7f53", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "fields", ":flowFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the field/attribute that you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de432f32-76bd-4281-8e07-d3f8f00d6f38", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "fields", ":flowFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the field/attribute that you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2a200ad-7650-44e7-830f-6bb1e0c68d5d", "name": "Get all Fields by Flow", "request": { "name": "Get all Fields by Flow", "description": { "content": "Get all Fields by Flow", "type": "text/plain" }, "url": { "path": [ "v2", "flows", ":flowSlug", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "flowSlug", "disabled": false, "description": { "content": "(Required) The slug of the flow the entry belongs to.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "64c8723e-ff91-4037-b760-dd2faea44677", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" } ] }, "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\": \"23d26fd2-d2e2-4c72-b4b4-3ef7a31bc47f\",\n \"type\": \"field\",\n \"field_type\": \"string\",\n \"slug\": \"background_color\",\n \"name\": \"background colors\",\n \"description\": \"background color for the product\",\n \"required\": false,\n \"default\": \"#ffffff\",\n \"enabled\": true,\n \"validation_rules\": [],\n \"order\": null,\n \"omit_null\": false,\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/flows/248c7776-bd9f-4075-8980-461b02ed3757/fields/23d26fd2-d2e2-4c72-b4b4-3ef7a31bc47f\"\n },\n \"relationships\": {\n \"flow\": {\n \"data\": {\n \"id\": \"248c7776-bd9f-4075-8980-461b02ed3757\",\n \"type\": \"flow\"\n }\n }\n },\n \"meta\": {\n \"owner\": \"organization\",\n \"timestamps\": {\n \"created_at\": \"2017-06-26T12:55:33.560Z\",\n \"updated_at\": \"2017-12-19T12:31:24.570Z\"\n }\n }\n },\n {\n \"id\": \"5f4be5bd-0c83-417a-b744-7d8c49636ab1\",\n \"type\": \"field\",\n \"field_type\": \"string\",\n \"slug\": \"background_image\",\n \"name\": \"Background Image\",\n \"description\": \"The background image for the category\",\n \"required\": false,\n \"default\": null,\n \"enabled\": true,\n \"validation_rules\": [],\n \"order\": null,\n \"omit_null\": false,\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/flows/248c7776-bd9f-4075-8980-461b02ed3757/fields/5f4be5bd-0c83-417a-b744-7d8c49636ab1\"\n },\n \"relationships\": {\n \"flow\": {\n \"data\": {\n \"id\": \"248c7776-bd9f-4075-8980-461b02ed3757\",\n \"type\": \"flow\"\n }\n }\n },\n \"meta\": {\n \"owner\": \"organization\",\n \"timestamps\": {\n \"created_at\": \"2018-03-29T10:33:24.056Z\",\n \"updated_at\": \"2018-03-29T10:33:24.056Z\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e970af82-4568-43d4-9bd1-6aea32f613ce", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1811561f-c2a4-408a-a7d1-720e49488883", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Entries", "description": "### Entries in Commerce\n\nEntries hold the pieces of data collected within the fields. If your flow has more than one field related to it, you see multiple field slugs.\n\n### Entries in Product Experience Manager\n\nEntries hold the pieces of data collected within the attributes. If your template has more than one attribute related to it, you see multiple attribute slugs.\n", "item": [ { "id": "2affc0a8-f1d3-417b-8dfe-c5f91a2d6dc1", "name": "Get all Entries", "request": { "name": "Get all Entries", "description": { "content": "- For Commerce, this endpoint retrieves all entries for a flow.\n- For Product Experience Manager, this endpoint retrieves all entries for a template.\n", "type": "text/plain" }, "url": { "path": [ "v2", "flows", ":flowSlug", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.\n", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.\n", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "type": "any", "value": "string", "key": "flowSlug", "disabled": false, "description": { "content": "(Required) The slug for the flow/template you want to create an entry for.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "83dbe80a-0e47-4c01-93c0-1ff99d7454a7", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.\n", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.\n", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template you want to create an entry for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" } ] }, "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\": \"ce1f0b19-23c3-487b-aa2a-552b77abdf0c\",\n \"type\": \"entry\",\n \"brand-image\": \"https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/61118f21-14a2-466c-a84b-c30b1f900cf9.png\",\n \"meta\": {\n \"owner\": \"organization\",\n \"timestamps\": {\n \"created_at\": \"2018-06-05T20:58:25.596Z\",\n \"updated_at\": \"2018-06-05T20:58:25.596Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/flows/brands/entries/ce1f0b19-23c3-487b-aa2a-552b77abdf0c\"\n }\n },\n {\n \"id\": \"a5fcf6bc-233f-44d7-a3b0-0961eed3df9d\",\n \"type\": \"entry\",\n \"brand-image\": \"some image for brand x\",\n \"meta\": {\n \"owner\": \"organization\",\n \"timestamps\": {\n \"created_at\": \"2018-06-06T14:48:59.006Z\",\n \"updated_at\": \"2018-06-06T14:48:59.006Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/flows/brands/entries/a5fcf6bc-233f-44d7-a3b0-0961eed3df9d\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6d5ab5c-8a77-454b-91cb-816eba55a145", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.\n", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.\n", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template you want to create an entry for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42c4e73a-5561-4f28-9574-9188ea2a7d9f", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.\n", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.\n", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template you want to create an entry for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e326311-822b-4d68-b7e7-7066c10ea6bd", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.\n", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.\n", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template you want to create an entry for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" } ] }, "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 \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0acd28d-9852-43f6-85d1-87db7185747c", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.\n", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.\n", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template you want to create an entry for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88585cac-3172-4358-b90a-d9309539a4d1", "name": "Create an Entry", "request": { "name": "Create an Entry", "description": { "content": "- For Commerce, this endpoint creates an entry for a flow.\n- For Product Experience Manager, this endpoint creates an entry for a template.\n", "type": "text/plain" }, "url": { "path": [ "v2", "flows", ":flowSlug", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "flowSlug", "disabled": false, "description": { "content": "(Required) The slug for the flow/template you want to create an entry for.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"FIELD_SLUG\": \"a value\",\n \"type\": \"entry\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "056eb77b-4592-44ad-a589-083edeb92ed1", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template you want to create an entry for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"FIELD_SLUG\": \"a value\",\n \"type\": \"entry\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"10fe2aca-09fb-42fe-a1d4-081134320641\",\n \"type\": \"entry\",\n \"meta\": {\n \"owner\": \"organization\",\n \"timestamps\": {\n \"created_at\": \"2021-10-26T17:10:56.329Z\",\n \"updated_at\": \"2021-10-26T17:10:56.329Z\"\n }\n },\n \"links\": {\n \"self\": \"https://epcc-integration.global.ssl.fastly.net/v2/flows/products/entries/10fe2aca-09fb-42fe-a1d4-081134320641\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "384e5e66-56b6-49cc-82f1-bae76ffb4e27", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template you want to create an entry for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"FIELD_SLUG\": \"a value\",\n \"type\": \"entry\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16c01a72-7b10-4bf1-8f66-68cf35e8fbf4", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template you want to create an entry for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"FIELD_SLUG\": \"a value\",\n \"type\": \"entry\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4571e14-b1c4-4c05-ac06-1f7148b031ed", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template you want to create an entry for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"FIELD_SLUG\": \"a value\",\n \"type\": \"entry\"\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 \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "268bb7bd-2c52-4216-925d-9f22ddfdb141", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template you want to create an entry for.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"FIELD_SLUG\": \"a value\",\n \"type\": \"entry\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31e67d20-b510-4598-a01d-fb8666c61fe4", "name": "Get an Entry", "request": { "name": "Get an Entry", "description": { "content": "- For Commerce, this endpoint retrieves an entry from a flow.\n- For Product Experience Manager, this endpoint retrieves an entry from a template.\n", "type": "text/plain" }, "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "flowSlug", "disabled": false, "description": { "content": "(Required) The slug for the flow/template.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "flowEntryID", "disabled": false, "description": { "content": "(Required) The ID of the entry.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "385421d9-d5b5-4daa-9d0b-6fdc7f22f7f0", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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 \"id\": \"4abb8316-d0a2-4c91-bf29-4d19ba932227\",\n \"type\": \"entry\",\n \"meta\": {\n \"owner\": \"organization\",\n \"timestamps\": {\n \"created_at\": \"2018-05-10T15:28:59.192Z\",\n \"updated_at\": \"2018-05-10T15:28:59.192Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/flows/products/entries/4abb8316-d0a2-4c91-bf29-4d19ba932227\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97c64456-1368-4c63-b50c-a91537b259ad", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "737a9ae2-9cd9-456e-b64c-f952387bce5a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1f64388-1a2e-4a29-9439-b64634c9a5e8", "name": "Delete an Entry", "request": { "name": "Delete an Entry", "description": { "content": "- For Commerce, this endpoint deletes an entry from a flow.\n- For Product Experience Manager, this endpoint deletes an entry from a template.\n", "type": "text/plain" }, "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "flowSlug", "disabled": false, "description": { "content": "(Required) The slug for the flow/template.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "flowEntryID", "disabled": false, "description": { "content": "(Required) The ID of the entry.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "ae57fab7-0878-4081-8085-889f7160f9f4", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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": "09389300-1cdc-4689-bf5b-f50d5a675d7e", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b5a4790-3229-47e9-8b1f-0ddea0017913", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a74136ea-aa05-43a0-895a-280f8d7f3d1c", "name": "Update an Entry", "request": { "name": "Update an Entry", "description": { "content": "- For Commerce, this endpoint updates an entry for a flow.\n- For Product Experience Manager, this endpoint updates an entry for a template.\n", "type": "text/plain" }, "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "flowSlug", "disabled": false, "description": { "content": "(Required) The slug for the flow/template.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "flowEntryID", "disabled": false, "description": { "content": "(Required) The ID of the entry.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"FIELD1_SLUG\": \"value1\",\n \"FIELD2_SLUG\": \"value2\",\n \"id\": \"{{entryID}}\",\n \"type\": \"entry\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f9c0fd9e-dae4-4628-8999-adcb76742cb5", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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 \"data\": {\n \"FIELD1_SLUG\": \"value1\",\n \"FIELD2_SLUG\": \"value2\",\n \"id\": \"{{entryID}}\",\n \"type\": \"entry\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"03224af8-da41-4761-99fb-a125fa81ed99\",\n \"type\": \"entry\",\n \"brand-image\": \"a new image\",\n \"meta\": {\n \"owner\": \"organization\",\n \"timestamps\": {\n \"created_at\": \"2018-06-06T14:42:39.312Z\",\n \"updated_at\": \"2018-06-06T14:42:39.312Z\"\n }\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/flows/brands/entries/03224af8-da41-4761-99fb-a125fa81ed99\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5aa75e4-d07c-4fc6-a642-7683a8a00d3f", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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 \"data\": {\n \"FIELD1_SLUG\": \"value1\",\n \"FIELD2_SLUG\": \"value2\",\n \"id\": \"{{entryID}}\",\n \"type\": \"entry\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b275794-5daf-4be6-bc74-25bb6c16bf43", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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 \"data\": {\n \"FIELD1_SLUG\": \"value1\",\n \"FIELD2_SLUG\": \"value2\",\n \"id\": \"{{entryID}}\",\n \"type\": \"entry\"\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 \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3a93d4f-ddf4-41ff-beec-06ee88bba23f", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug for the flow/template.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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 \"data\": {\n \"FIELD1_SLUG\": \"value1\",\n \"FIELD2_SLUG\": \"value2\",\n \"id\": \"{{entryID}}\",\n \"type\": \"entry\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Entry Relationships", "description": "\n### Entry Relationships in Commerce\n\nWhen you create a field that uses `relationship` as a `field_type`, you update your entry values using the `Entry Relationship` endpoints. \n\n### Entry Relationships in Product Experience Manager\n\nOnce you have created your templates, you must associate them with your products using the `Entry Relationship` endpoints.\n", "item": [ { "id": "7f950b02-82e5-4655-9ac0-e032297c5fbf", "name": "Create an Entry Relationship", "request": { "name": "Create an Entry Relationship", "description": { "content": "- In Commerce, create an entry relationship to one or more resources. If any relationships already exist, the ones made in the request are added to them.\n- In Product Experience Manager, create an entry relationship with the product to which you want to associate the template.\n", "type": "text/plain" }, "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "flowSlug", "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "flowEntryID", "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "flowFieldSlug", "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n },\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0ea0104d-cfb5-4e92-80e1-38ed4602cfd1", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n },\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"type\": \"brand\",\n \"id\": \"0d28e5b6-f615-4e1c-b038-275cfde97927\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63fabc0d-19d2-43fb-9ab4-a62e8a6d347d", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n },\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e6525a2-6aa6-4a1f-a7aa-8d04eb5452c5", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n },\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\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 \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22a9681c-bc75-4846-9494-b1b99d618644", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n },\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "93bf874b-5b89-4b3f-9cd0-503d2a42e4fe", "name": "Update an Entry Relationship", "request": { "name": "Update an Entry Relationship", "description": { "content": "- In Commerce, updates an entry relationship to one or more resources. If any relationships already exist, the ones made in the request are added to them.\n- In Product Experience Manager, updates an entry relationship with the product to which you want to associate the template.\n", "type": "text/plain" }, "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "flowSlug", "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "flowEntryID", "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "flowFieldSlug", "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n },\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2c1b43ea-9bf5-4169-bd39-92bde88dfed0", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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 \"data\": [\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n },\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"type\": \"brand\",\n \"id\": \"0d28e5b6-f615-4e1c-b038-275cfde97927\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73a225f4-2b78-4711-b495-14e65ee53c34", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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 \"data\": [\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n },\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dff1b97-fea1-426c-b53d-1b4e56b6d3ce", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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 \"data\": [\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n },\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\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 \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d255ebec-35fb-44e4-bb18-72411698bd5b", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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 \"data\": [\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n },\n {\n \"id\": \"{RESOURCE_ID}\",\n \"type\": \"{RESOURCE_TYPE}\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4be4f06e-2659-4812-b673-59dcd27c1c19", "name": "Delete an Entry Relationship", "request": { "name": "Delete an Entry Relationship", "description": { "content": "- In Commerce, deletes an entry relationship to one or more resources. \n- In Product Experience Manager, deletes an entry relationship with the product to which you want to associate the template.\n", "type": "text/plain" }, "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "flowSlug", "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "flowEntryID", "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "flowFieldSlug", "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "2a2f89c4-9f91-4dc6-85d3-7d86b40e47ee", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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": "add920a4-1119-49fb-9ddd-c1b2b791fbe0", "name": "Bad request. Not Found.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f697cee9-e87e-4d0e-9071-6980db31ca0d", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "flows", ":flowSlug", "entries", ":flowEntryID", "relationships", ":flowFieldSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the flow/template that the entry belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowSlug" }, { "disabled": false, "description": { "content": "(Required) The slug of the field/attribute that the relationship belongs to.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowFieldSlug" }, { "disabled": false, "description": { "content": "(Required) The ID of the entry you are requesting.", "type": "text/plain" }, "type": "any", "value": "string", "key": "flowEntryID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 500,\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Integrations", "description": "Setting up and managing integrations.", "item": [ { "id": "db20b9e0-3091-4ab8-b4a2-993523b151f3", "name": "List integrations", "request": { "name": "List integrations", "description": { "content": "Returns a list of all integrations created by the store.", "type": "text/plain" }, "url": { "path": [ "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6199936b-2f91-4813-8e34-0222b347247f", "name": "Success. All integrations are returned.", "originalRequest": { "url": { "path": [ "integrations" ], "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" } ], "body": "{\n \"data\": [\n {\n \"id\": \"2da46671-b4c2-44ac-b133-d1221aafc77b\",\n \"type\": \"integration\",\n \"name\": \"Order shipping notification\",\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"integration_type\": \"webhook\",\n \"observes\": [\n \"string\",\n \"string\"\n ],\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\n },\n \"links\": {\n \"self\": \"https://ECeWoMNYWcWqbRUzaIIjfvPUrYcktE.xhhpoCdVaWHEoBVIj2SuY+f6fWBLyAKG605.GMTNXmKHiTm24az\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-07-21T17:32:28Z\",\n \"updated_at\": \"2017-07-21T17:32:28Z\"\n }\n }\n },\n {\n \"id\": \"2da46671-b4c2-44ac-b133-d1221aafc77b\",\n \"type\": \"integration\",\n \"name\": \"Order shipping notification\",\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"integration_type\": \"webhook\",\n \"observes\": [\n \"string\",\n \"string\"\n ],\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\n },\n \"links\": {\n \"self\": \"http://suEOnqXo.bqcwmx3y4aj8GmNm3-+KE-YKc-sRXLyjHT\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-07-21T17:32:28Z\",\n \"updated_at\": \"2017-07-21T17:32:28Z\"\n }\n }\n }\n ],\n \"links\": {\n \"first\": \"/integrations?page[offset]=0&page[limit]=10\",\n \"last\": \"/integrations?page[offset]=20&page[limit]=10\",\n \"next\": \"/integrations?page[offset]=10&page[limit]=10\",\n \"prev\": \"/integrations?page[offset]=8&page[limit]=10\"\n },\n \"results\": {\n \"total\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec6ba906-dda7-4e29-a205-0ab6cd107883", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "integrations" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": 500\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa8c2358-bae9-43b6-9773-6ee0bfcfff60", "name": "Create an integration", "request": { "name": "Create an integration", "description": { "content": "Create an integration.", "type": "text/plain" }, "url": { "path": [ "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"integration\",\n \"integration_type\": \"webhook\",\n \"name\": \"Order shipping notification\",\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\n },\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"observes\": [\n \"string\",\n \"string\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ca14c4f6-ceb1-4fd8-bfb2-bc698d28aa36", "name": "Success. Integration created.", "originalRequest": { "url": { "path": [ "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"integration\",\n \"integration_type\": \"webhook\",\n \"name\": \"Order shipping notification\",\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\n },\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"observes\": [\n \"string\",\n \"string\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"2da46671-b4c2-44ac-b133-d1221aafc77b\",\n \"type\": \"integration\",\n \"name\": \"Order shipping notification\",\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"integration_type\": \"webhook\",\n \"observes\": [\n \"string\",\n \"string\"\n ],\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\n },\n \"links\": {\n \"self\": \"https://zbdmKEKYlYWJabCnai.kyCmhG-l9NHxqmODg+8yErsV2\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-07-21T17:32:28Z\",\n \"updated_at\": \"2017-07-21T17:32:28Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aebdd48-b08c-4360-b8e6-8fc6d77cd99d", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"integration\",\n \"integration_type\": \"webhook\",\n \"name\": \"Order shipping notification\",\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\n },\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"observes\": [\n \"string\",\n \"string\"\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 \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6008047-c400-498c-8aa5-14101b2afde8", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"integration\",\n \"integration_type\": \"webhook\",\n \"name\": \"Order shipping notification\",\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\n },\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"observes\": [\n \"string\",\n \"string\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": 500\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd3a3304-2b9e-4049-a248-b1d615be77e3", "name": "Get an integration", "request": { "name": "Get an integration", "description": { "content": "Returns the integration for the given UUID.", "type": "text/plain" }, "url": { "path": [ "integrations", ":integration_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "integration_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5c6d0615-959d-4125-a17b-8a059992e66f", "name": "Success. An integration is returned.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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 \"id\": \"2da46671-b4c2-44ac-b133-d1221aafc77b\",\n \"type\": \"integration\",\n \"name\": \"Order shipping notification\",\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"integration_type\": \"webhook\",\n \"observes\": [\n \"string\",\n \"string\"\n ],\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\n },\n \"links\": {\n \"self\": \"https://zbdmKEKYlYWJabCnai.kyCmhG-l9NHxqmODg+8yErsV2\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-07-21T17:32:28Z\",\n \"updated_at\": \"2017-07-21T17:32:28Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d6ea0e8-b84f-4caf-a7ad-84d540d8696a", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404,\n \"detail\": \"The resource could not be found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eed7dcce-308b-4134-9a83-d341d06d1b60", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": 500\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "096bfa6d-9ca4-40e6-b112-993adb828b08", "name": "Update an integration", "request": { "name": "Update an integration", "description": { "content": "Updates the Integration for the given UUID. Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the integration is not updated.", "type": "text/plain" }, "url": { "path": [ "integrations", ":integration_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "integration_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"integration\",\n \"name\": \"Order shipping notification\",\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"integration_type\": \"webhook\",\n \"observes\": [\n \"string\",\n \"string\"\n ],\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ec1391b7-9d38-4f71-a8d4-55e2b5b7c375", "name": "Success. All integrations are returned", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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 \"data\": {\n \"type\": \"integration\",\n \"name\": \"Order shipping notification\",\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"integration_type\": \"webhook\",\n \"observes\": [\n \"string\",\n \"string\"\n ],\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"2da46671-b4c2-44ac-b133-d1221aafc77b\",\n \"type\": \"integration\",\n \"name\": \"Order shipping notification\",\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"integration_type\": \"webhook\",\n \"observes\": [\n \"string\",\n \"string\"\n ],\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\n },\n \"links\": {\n \"self\": \"http://yunzvzUkwzY.jqopZPaNNNK3F1OTDlF-CfVRFja\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-07-21T17:32:28Z\",\n \"updated_at\": \"2017-07-21T17:32:28Z\"\n }\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"https://WhHgVVMqdlgbkqPuxxFAAVFYPM.hookx\"\n }\n },\n \"meta\": {\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-07-21T17:32:28Z\",\n \"updated_at\": \"2017-07-21T17:32:28Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba36052e-ec57-4252-bdac-acbe3fc0236a", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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 \"data\": {\n \"type\": \"integration\",\n \"name\": \"Order shipping notification\",\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"integration_type\": \"webhook\",\n \"observes\": [\n \"string\",\n \"string\"\n ],\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404,\n \"detail\": \"The resource could not be found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "038f783c-e383-40c5-ab84-b5bddf201aa9", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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 \"data\": {\n \"type\": \"integration\",\n \"name\": \"Order shipping notification\",\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"integration_type\": \"webhook\",\n \"observes\": [\n \"string\",\n \"string\"\n ],\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\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 \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": 400,\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e719b33-5936-403d-99ed-5fea583217ad", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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 \"data\": {\n \"type\": \"integration\",\n \"name\": \"Order shipping notification\",\n \"description\": \"Send a shipping notification via email with discount code\",\n \"enabled\": true,\n \"integration_type\": \"webhook\",\n \"observes\": [\n \"string\",\n \"string\"\n ],\n \"configuration\": {\n \"url\": \"https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue\",\n \"aws_access_key_id\": \"****************JIMB\",\n \"aws_secret_access_key\": \"************************************HK4o\",\n \"region\": \"eu-west-1\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": 500\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c4f7d93-5442-4fb0-beba-ae550190fc17", "name": "Delete an integration", "request": { "name": "Delete an integration", "description": { "content": "Deletes the Integration for the given UUID", "type": "text/plain" }, "url": { "path": [ "integrations", ":integration_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "integration_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "0f26e379-f5b9-4311-8e7e-330a1c439c52", "name": "Integration was successfully deleted", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "993d4ca4-8a69-4e49-affb-f760c2771425", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": 500\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9c05a5b-8107-4487-9aa6-239c6f0a896f", "name": "List logs for all integrations for the store", "request": { "name": "List logs for all integrations for the store", "description": { "content": "Returns all integration logs for the store.", "type": "text/plain" }, "url": { "path": [ "integrations", "logs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "98f6c0ed-4a34-4d0c-8d65-c18eaff6bd9b", "name": "Success. Returns a list of integration logs.", "originalRequest": { "url": { "path": [ "integrations", "logs" ], "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" } ], "body": "{\n \"data\": [\n {\n \"id\": \"ac8bb58e-2b9b-4ccf-9dd2-ecdf50417849\",\n \"type\": \"integration\",\n \"succeeded\": true,\n \"attempt\": 1,\n \"body\": \"Not Found\",\n \"status_code\": 404,\n \"error_detail\": \"Received a status code outside of 2xx range - treating webhook as a fail\",\n \"relationships\": {\n \"integration\": {\n \"data\": {\n \"id\": \"ff8634a8-a89e-4eac-baab-9b7b8c4f8720\",\n \"type\": \"integration\"\n }\n },\n \"job\": {\n \"data\": {\n \"id\": \"ff8634a8-a89e-4eac-baab-9b7b8c4f8720\",\n \"type\": \"job\"\n }\n }\n }\n },\n {\n \"id\": \"ac8bb58e-2b9b-4ccf-9dd2-ecdf50417849\",\n \"type\": \"integration\",\n \"succeeded\": true,\n \"attempt\": 1,\n \"body\": \"Not Found\",\n \"status_code\": 404,\n \"error_detail\": \"Received a status code outside of 2xx range - treating webhook as a fail\",\n \"relationships\": {\n \"integration\": {\n \"data\": {\n \"id\": \"ff8634a8-a89e-4eac-baab-9b7b8c4f8720\",\n \"type\": \"integration\"\n }\n },\n \"job\": {\n \"data\": {\n \"id\": \"ff8634a8-a89e-4eac-baab-9b7b8c4f8720\",\n \"type\": \"job\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"first\": \"/integrations/logs?page[offset]=0&page[limit]=10\",\n \"next\": \"/integrations/logs?page[offset]=10&page[limit]=10\",\n \"prev\": \"/integrations/logs?page[offset]=8&page[limit]=10\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f49942aa-c4fd-4cc0-865c-813115ca5c42", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "integrations", "logs" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": 500\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e801a12-9d65-48fe-94b7-fb2c71252507", "name": "List logs for integration", "request": { "name": "List logs for integration", "description": { "content": "Returns the logs for the given integration UUID.", "type": "text/plain" }, "url": { "path": [ "integrations", ":integration_uuid", "logs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "integration_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f733c6c5-43a4-43fe-92f6-db0738fe7292", "name": "Success. Returns a list of integration logs.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid", "logs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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\": \"ac8bb58e-2b9b-4ccf-9dd2-ecdf50417849\",\n \"type\": \"integration\",\n \"succeeded\": true,\n \"attempt\": 1,\n \"body\": \"Not Found\",\n \"status_code\": 404,\n \"error_detail\": \"Received a status code outside of 2xx range - treating webhook as a fail\",\n \"relationships\": {\n \"integration\": {\n \"data\": {\n \"id\": \"ff8634a8-a89e-4eac-baab-9b7b8c4f8720\",\n \"type\": \"integration\"\n }\n },\n \"job\": {\n \"data\": {\n \"id\": \"ff8634a8-a89e-4eac-baab-9b7b8c4f8720\",\n \"type\": \"job\"\n }\n }\n }\n },\n {\n \"id\": \"ac8bb58e-2b9b-4ccf-9dd2-ecdf50417849\",\n \"type\": \"integration\",\n \"succeeded\": true,\n \"attempt\": 1,\n \"body\": \"Not Found\",\n \"status_code\": 404,\n \"error_detail\": \"Received a status code outside of 2xx range - treating webhook as a fail\",\n \"relationships\": {\n \"integration\": {\n \"data\": {\n \"id\": \"ff8634a8-a89e-4eac-baab-9b7b8c4f8720\",\n \"type\": \"integration\"\n }\n },\n \"job\": {\n \"data\": {\n \"id\": \"ff8634a8-a89e-4eac-baab-9b7b8c4f8720\",\n \"type\": \"job\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"first\": \"/integrations/logs?page[offset]=0&page[limit]=10\",\n \"next\": \"/integrations/logs?page[offset]=10&page[limit]=10\",\n \"prev\": \"/integrations/logs?page[offset]=8&page[limit]=10\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3387552b-cd60-4b46-9906-3c2c04636c37", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid", "logs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404,\n \"detail\": \"The resource could not be found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea13a7cf-ad5d-4bd1-8495-004e995d7b1b", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid", "logs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": 500\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a0e9ff0-23ff-44a1-a33a-791a1be613ad", "name": "List jobs for integration", "request": { "name": "List jobs for integration", "description": { "content": "Returns the jobs for the given integration UUID.", "type": "text/plain" }, "url": { "path": [ "integrations", ":integration_uuid", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "integration_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "36422e1a-20f5-4591-833f-fd800133945d", "name": "Success. All integrations are returned.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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\": \"8848646b-2745-469e-8cc1-ee3b04738f8f\",\n \"type\": \"integration-job\"\n },\n {\n \"id\": \"8848646b-2745-469e-8cc1-ee3b04738f8f\",\n \"type\": \"integration-job\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d890b03-fe5b-4ccb-9225-06bfd9943347", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404,\n \"detail\": \"The resource could not be found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb9afb0f-cfc5-4d0b-9388-77fb6aaeeaf5", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": 500\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f65ae598-b5cf-40ed-b06d-320b473d5125", "name": "List logs for the job", "request": { "name": "List logs for the job", "description": { "content": "Returns the integration logs for the given integration and job UUID.", "type": "text/plain" }, "url": { "path": [ "integrations", ":integration_uuid", "jobs", ":job_uuid", "logs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "integration_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "job_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the integration job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6e2d577d-8f94-4560-b0ea-1a5f057b31f1", "name": "Success. Returns a list of integration logs.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid", "jobs", ":job_uuid", "logs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration job.", "type": "text/plain" }, "type": "any", "value": "string", "key": "job_uuid" } ] }, "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\": \"ac8bb58e-2b9b-4ccf-9dd2-ecdf50417849\",\n \"type\": \"integration\",\n \"succeeded\": true,\n \"attempt\": 1,\n \"body\": \"Not Found\",\n \"status_code\": 404,\n \"error_detail\": \"Received a status code outside of 2xx range - treating webhook as a fail\",\n \"relationships\": {\n \"integration\": {\n \"data\": {\n \"id\": \"ff8634a8-a89e-4eac-baab-9b7b8c4f8720\",\n \"type\": \"integration\"\n }\n },\n \"job\": {\n \"data\": {\n \"id\": \"ff8634a8-a89e-4eac-baab-9b7b8c4f8720\",\n \"type\": \"job\"\n }\n }\n }\n },\n {\n \"id\": \"ac8bb58e-2b9b-4ccf-9dd2-ecdf50417849\",\n \"type\": \"integration\",\n \"succeeded\": true,\n \"attempt\": 1,\n \"body\": \"Not Found\",\n \"status_code\": 404,\n \"error_detail\": \"Received a status code outside of 2xx range - treating webhook as a fail\",\n \"relationships\": {\n \"integration\": {\n \"data\": {\n \"id\": \"ff8634a8-a89e-4eac-baab-9b7b8c4f8720\",\n \"type\": \"integration\"\n }\n },\n \"job\": {\n \"data\": {\n \"id\": \"ff8634a8-a89e-4eac-baab-9b7b8c4f8720\",\n \"type\": \"job\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"first\": \"/integrations/logs?page[offset]=0&page[limit]=10\",\n \"next\": \"/integrations/logs?page[offset]=10&page[limit]=10\",\n \"prev\": \"/integrations/logs?page[offset]=8&page[limit]=10\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ce3cf6f-af60-4ff2-aca6-7bced06a97e8", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid", "jobs", ":job_uuid", "logs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration job.", "type": "text/plain" }, "type": "any", "value": "string", "key": "job_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": 404,\n \"detail\": \"The resource could not be found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bc0fe5a-66be-4993-ae75-21b8c56d4c94", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "integrations", ":integration_uuid", "jobs", ":job_uuid", "logs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration.", "type": "text/plain" }, "type": "any", "value": "string", "key": "integration_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the integration job.", "type": "text/plain" }, "type": "any", "value": "string", "key": "job_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": 500\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Inventory", "description": "The Inventory API allows you to manage stock for products at both organization and store levels. Each product keeps a history of inventory transactions, enabling easier stock auditing.\n\nYou can specify an initial stock level when you create a product. The stock is set to `0` by default.\n\n:::caution \n\nYou cannot create multiple inventories of the same organization-level product in different stores because no unique stock ID, specific to each store, is currently generated. Hence, when you try to manage inventory of the same product for different stores, you get an invalid product identifier error. \n\n:::\n", "item": [ { "id": "a36d56c9-a9d2-41a0-8217-5fc665cf0456", "name": "Get Stock for all Products", "request": { "name": "Get Stock for all Products", "description": { "content": "Returns all products and their associated stock.", "type": "text/plain" }, "url": { "path": [ "inventories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "76657ed2-ffc5-4ee9-84b6-c09952f874eb", "name": "Success. All products and their stock values are returned", "originalRequest": { "url": { "path": [ "inventories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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 \"type\": \"stock\",\n \"id\": \"f976dace-450f-4a5d-8877-d119c5a550a1\",\n \"total\": 100,\n \"available\": 75,\n \"allocated\": 25,\n \"stock_id\": \"ce9049af-bba2-4db2-8118-5df5268184c7\",\n \"meta\": {\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n {\n \"type\": \"stock\",\n \"id\": \"f976dace-450f-4a5d-8877-d119c5a550a1\",\n \"total\": 100,\n \"available\": 75,\n \"allocated\": 25,\n \"stock_id\": \"ce9049af-bba2-4db2-8118-5df5268184c7\",\n \"meta\": {\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n ],\n \"meta\": {\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5893eee9-4a6b-41ee-9818-d32d9d3e473f", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No stock found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "952e8bb1-2ed8-408c-8c70-bfd6c5ac98f2", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6b45623-496f-432a-82c7-d86785794969", "name": "Get Stock for Multiple Products", "request": { "name": "Get Stock for Multiple Products", "description": { "content": "Returns stock for all products matching the supplied unique identifiers.", "type": "text/plain" }, "url": { "path": [ "inventories", "multiple" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"ebc7652d-bb7d-4359-9a83-78f2998208d9\"\n },\n {\n \"id\": \"5334e697-a576-4ac5-8075-ab457dfcaddd\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5204b461-7d67-4555-a1ba-966d1a21a3cd", "name": "Success. Multiple products and their stock values are returned.", "originalRequest": { "url": { "path": [ "inventories", "multiple" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"ebc7652d-bb7d-4359-9a83-78f2998208d9\"\n },\n {\n \"id\": \"5334e697-a576-4ac5-8075-ab457dfcaddd\"\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\": \"ebc7652d-bb7d-4359-9a83-78f2998208d9\",\n \"type\": \"stock\",\n \"total\": 100,\n \"available\": 75,\n \"allocated\": 25\n },\n {\n \"id\": \"5334e697-a576-4ac5-8075-ab457dfcaddd\",\n \"type\": \"stock\",\n \"total\": 22,\n \"available\": 18,\n \"allocated\": 4\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70657eb8-2ced-47c0-b1df-2e4c9610bff9", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", "multiple" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"ebc7652d-bb7d-4359-9a83-78f2998208d9\"\n },\n {\n \"id\": \"5334e697-a576-4ac5-8075-ab457dfcaddd\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No stock found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d5824b6-3038-46d0-a99a-307edb241865", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", "multiple" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"ebc7652d-bb7d-4359-9a83-78f2998208d9\"\n },\n {\n \"id\": \"5334e697-a576-4ac5-8075-ab457dfcaddd\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75fc015e-0d94-43e4-8c5a-40636de66bc9", "name": "Create Stock for Product", "request": { "name": "Create Stock for Product", "description": { "content": "Sets the inventory quantity for the specified product. When you take this action, you are choosing to manage the inventory for this product in Commerce.", "type": "text/plain" }, "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"quantity\": 5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ca85dd1c-8013-4bb7-b50f-b416b6e59603", "name": "Success. Stock was successfully created for product", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"quantity\": 5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"stock\",\n \"id\": \"f976dace-450f-4a5d-8877-d119c5a550a1\",\n \"total\": 100,\n \"available\": 75,\n \"allocated\": 25,\n \"stock_id\": \"ce9049af-bba2-4db2-8118-5df5268184c7\",\n \"meta\": {\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aa65922-acd3-4080-a798-4fd57f6bfe40", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"quantity\": 5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94e4e606-f7ff-4604-b8d2-c336016e685e", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"quantity\": 5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No stock found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a831e07e-988f-42ca-b302-228a7823cbfa", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"quantity\": 5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e0dda613-8772-43fd-b68f-7a3111d97923", "name": "Get Stock for Product", "request": { "name": "Get Stock for Product", "description": { "content": "Gets the stock for the product matching the specified unique identifier.", "type": "text/plain" }, "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "931aeca4-376e-4f9f-837d-d554fd7f0400", "name": "Success. Returns the stock for the given product UUID", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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 \"type\": \"stock\",\n \"id\": \"f976dace-450f-4a5d-8877-d119c5a550a1\",\n \"total\": 100,\n \"available\": 75,\n \"allocated\": 25,\n \"stock_id\": \"ce9049af-bba2-4db2-8118-5df5268184c7\",\n \"meta\": {\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"meta\": {\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "943ffb6c-38f4-4dbe-bf66-41f6ba2d6f14", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No stock found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3214902-8697-4e0b-b2bd-b0700c81fd7d", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "398bee91-1738-4de1-b761-36d968fd14cb", "name": "Delete Stock for Product", "request": { "name": "Delete Stock for Product", "description": { "content": "Deletes the inventory for the specified product. The product inventory is null and is no longer managed by Commerce. If you want to keep managing inventory but have none of the product in stock, set the inventory to `0` instead of deleting the inventory.", "type": "text/plain" }, "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "581be704-9587-4c18-8fea-76cbc4e05b69", "name": "Success. Removes the stock information about the product", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "68d369db-024c-42a0-a346-b000d925b720", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dc057c9-0d4b-46e1-8437-8002eb7c080d", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No stock found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "342c8acd-5e73-4dd4-9c01-3a9779bb7d02", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Transactions", "description": "Methods to allow you to modify and view a products stock via transactions.", "item": [ { "id": "3a1ac9c6-09ad-4477-b087-6c6259edb0f3", "name": "Get Stock Transactions for Product", "request": { "name": "Get Stock Transactions for Product", "description": { "content": "Returns the transactions recorded for the specified product.", "type": "text/plain" }, "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7b5cbcd1-09f9-4a56-884e-81bb66f66d27", "name": "Success. Returns the stock for the given product", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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 \"meta\": {\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"data\": [\n {\n \"type\": \"stock-transaction\",\n \"id\": \"f976dace-450f-4a5d-8877-d119c5a550a1\",\n \"action\": \"allocate\",\n \"product_id\": \"86b84d3e-0a86-43d6-a347-78ba4adacca2\",\n \"quantity\": 5,\n \"timestamps\": {\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n {\n \"type\": \"stock-transaction\",\n \"id\": \"f976dace-450f-4a5d-8877-d119c5a550a1\",\n \"action\": \"allocate\",\n \"product_id\": \"86b84d3e-0a86-43d6-a347-78ba4adacca2\",\n \"quantity\": 5,\n \"timestamps\": {\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecf2ecdb-e330-48ea-96df-c5cd98877f58", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e157e14-6452-47ce-956b-4ac6bb52e35e", "name": "Create Stock Transaction on Product", "request": { "name": "Create Stock Transaction on Product", "description": {}, "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"allocate\",\n \"type\": \"stock-transaction\",\n \"product_id\": \"b9ad64bd-fc21-4918-b6ec-768809f4a1e9\",\n \"quantity\": 5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8e05fd7b-0345-49f6-86b6-5fa62acc10f1", "name": "Success. Stock was successfully modified for product", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"allocate\",\n \"type\": \"stock-transaction\",\n \"product_id\": \"b9ad64bd-fc21-4918-b6ec-768809f4a1e9\",\n \"quantity\": 5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"stock-transaction\",\n \"id\": \"f976dace-450f-4a5d-8877-d119c5a550a1\",\n \"action\": \"allocate\",\n \"product_id\": \"86b84d3e-0a86-43d6-a347-78ba4adacca2\",\n \"quantity\": 5,\n \"timestamps\": {\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76a52dc6-f8a9-4d0c-bf51-7272fdc56c10", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"allocate\",\n \"type\": \"stock-transaction\",\n \"product_id\": \"b9ad64bd-fc21-4918-b6ec-768809f4a1e9\",\n \"quantity\": 5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No stock found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70172124-8356-4695-bad6-ea3307b5d9d6", "name": "The request was understood, but could not be processed by the server", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"allocate\",\n \"type\": \"stock-transaction\",\n \"product_id\": \"b9ad64bd-fc21-4918-b6ec-768809f4a1e9\",\n \"quantity\": 5\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 \"errors\": [\n {\n \"title\": \"Cannot complete request\",\n \"status\": \"422\",\n \"detail\": \"Your request could not be completed due to insufficient stock levels\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47f37ac7-19c8-4c19-99ff-40d13371d149", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"allocate\",\n \"type\": \"stock-transaction\",\n \"product_id\": \"b9ad64bd-fc21-4918-b6ec-768809f4a1e9\",\n \"quantity\": 5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "729e9fbf-6644-4adc-98a1-5b7afe96fc20", "name": "Get Single Stock Transaction for Product", "request": { "name": "Get Single Stock Transaction for Product", "description": { "content": "Returns the specific transaction with transaction_uuid for product_uuid", "type": "text/plain" }, "url": { "path": [ "inventories", ":product_uuid", "transactions", ":transaction_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "transaction_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5838ab63-ede8-42c4-b41c-0786c8298455", "name": "Success. Returns the stock transaction for the given product", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions", ":transaction_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "transaction_uuid" } ] }, "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 \"type\": \"stock-transaction\",\n \"id\": \"f976dace-450f-4a5d-8877-d119c5a550a1\",\n \"action\": \"allocate\",\n \"product_id\": \"86b84d3e-0a86-43d6-a347-78ba4adacca2\",\n \"quantity\": 5,\n \"timestamps\": {\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4eb2a706-2d59-4000-be5e-f8db7305c722", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions", ":transaction_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "transaction_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No stock found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "137885d3-50bb-4acd-b11b-904c220b8f49", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions", ":transaction_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "transaction_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Inventory", "description": "The Inventory API allows you to manage stock for products at both organization and store levels. Each product keeps a history of inventory transactions, enabling easier stock auditing.\n\nYou can specify an initial stock level when you create a product. The stock is set to `0` by default.\n\n:::caution \n\nYou cannot create multiple inventories of the same organization-level product in different stores because no unique stock ID, specific to each store, is currently generated. Hence, when you try to manage inventory of the same product for different stores, you get an invalid product identifier error. \n\n:::\n", "item": [ { "id": "c22073d6-1a5f-49bd-b8fb-25c2350cfe0b", "name": "Create Stock for Product", "request": { "name": "Create Stock for Product", "description": { "content": "Sets the inventory quantity for the specified product.", "type": "text/plain" }, "url": { "path": [ "inventories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock\",\n \"attributes\": {\n \"available\": 20,\n \"locations\": {\n \"york_warehouse\": {\n \"available\": 10\n },\n \"stevenage_warehouse\": {\n \"available\": 20\n }\n }\n },\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4a8d14e9-abe6-4266-ad7a-6f14d09a29d1", "name": "Success. Stock was successfully created for product", "originalRequest": { "url": { "path": [ "inventories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock\",\n \"attributes\": {\n \"available\": 20,\n \"locations\": {\n \"york_warehouse\": {\n \"available\": 10\n },\n \"stevenage_warehouse\": {\n \"available\": 20\n }\n }\n },\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock\",\n \"attributes\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10,\n \"locations\": {\n \"key_0\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n },\n \"key_1\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n },\n \"key_2\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n }\n }\n },\n \"meta\": {\n \"stock_id\": \"00000000-0000-0000-0000-000000000000\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e1a22ed-8db3-48f5-b017-b2ee4925bf68", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "inventories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock\",\n \"attributes\": {\n \"available\": 20,\n \"locations\": {\n \"york_warehouse\": {\n \"available\": 10\n },\n \"stevenage_warehouse\": {\n \"available\": 20\n }\n }\n },\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfef24db-4c99-48f2-b6b4-77634a1df7cc", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock\",\n \"attributes\": {\n \"available\": 20,\n \"locations\": {\n \"york_warehouse\": {\n \"available\": 10\n },\n \"stevenage_warehouse\": {\n \"available\": 20\n }\n }\n },\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "04b62c0a-bfc1-40b1-a765-1a13b77d8d75", "name": "Get Stock for all Products", "request": { "name": "Get Stock for all Products", "description": { "content": "Returns all products and their associated stock.", "type": "text/plain" }, "url": { "path": [ "inventories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5cf59529-a64b-44e2-b1b1-5ac54f911f68", "name": "Success. All products and their stock values are returned", "originalRequest": { "url": { "path": [ "inventories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" } ], "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\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock\",\n \"attributes\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10,\n \"locations\": {\n \"key_0\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n },\n \"key_1\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n }\n }\n },\n \"meta\": {\n \"stock_id\": \"00000000-0000-0000-0000-000000000000\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock\",\n \"attributes\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10,\n \"locations\": {\n \"key_0\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n },\n \"key_1\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n }\n }\n },\n \"meta\": {\n \"stock_id\": \"00000000-0000-0000-0000-000000000000\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6e98f98-6131-47fe-b25a-66141c5d76a8", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" } ], "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": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No location found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ba7d890-ad1c-40e0-880d-bb38be6b1d7a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76c37681-2366-4644-99c5-273d32d5f290", "name": "List Stock", "request": { "name": "List Stock", "description": { "content": "Returns stock for all products matching the supplied unique identifiers.", "type": "text/plain" }, "url": { "path": [ "inventories", "multiple" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"ebc7652d-bb7d-4359-9a83-78f2998208d9\"\n },\n {\n \"id\": \"5334e697-a576-4ac5-8075-ab457dfcaddd\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fec4a2bf-4fea-4181-9f6e-f1474ce0a3d4", "name": "Success. Multiple products and their stock values are returned.", "originalRequest": { "url": { "path": [ "inventories", "multiple" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"ebc7652d-bb7d-4359-9a83-78f2998208d9\"\n },\n {\n \"id\": \"5334e697-a576-4ac5-8075-ab457dfcaddd\"\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\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock\",\n \"attributes\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10,\n \"locations\": {\n \"key_0\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n },\n \"key_1\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n },\n \"key_2\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n }\n }\n },\n \"meta\": {\n \"stock_id\": \"00000000-0000-0000-0000-000000000000\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock\",\n \"attributes\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10,\n \"locations\": {\n \"key_0\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n }\n }\n },\n \"meta\": {\n \"stock_id\": \"00000000-0000-0000-0000-000000000000\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b26bb01d-dc0b-402b-9e31-c6a7042fc4b6", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", "multiple" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"ebc7652d-bb7d-4359-9a83-78f2998208d9\"\n },\n {\n \"id\": \"5334e697-a576-4ac5-8075-ab457dfcaddd\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No location found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3957691-4f68-4fa4-ba7e-e4ce94460dec", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", "multiple" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"ebc7652d-bb7d-4359-9a83-78f2998208d9\"\n },\n {\n \"id\": \"5334e697-a576-4ac5-8075-ab457dfcaddd\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e4197ab-e70e-45c3-9724-fc23fa67a2a6", "name": "Get Stock for Product", "request": { "name": "Get Stock for Product", "description": { "content": "Gets the stock for the product matching the specified unique identifier.", "type": "text/plain" }, "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "def8bd57-f187-4527-bec4-202cd3706bd0", "name": "Success. Returns the stock for the given product UUID", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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 \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock\",\n \"attributes\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10,\n \"locations\": {\n \"key_0\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n },\n \"key_1\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n },\n \"key_2\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n }\n }\n },\n \"meta\": {\n \"stock_id\": \"00000000-0000-0000-0000-000000000000\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0629dd0a-f3a8-4cc9-ba37-aae9ef8694e0", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No location found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5109b8b0-cae5-4588-83e4-4e329c9a7ec8", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a529c28-668a-47e1-935d-d401e614dc84", "name": "Update Stock for Product", "request": { "name": "Update Stock for Product", "description": { "content": "Updates the inventory for the specified product.", "type": "text/plain" }, "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock\",\n \"attributes\": {\n \"locations\": {\n \"key_0\": {\n \"available\": 20\n },\n \"key_1\": {\n \"available\": 20\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "70e05bf4-fe10-43ea-8b40-4408a8e00bf5", "name": "Success. The stock item was updated successfully.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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 \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock\",\n \"attributes\": {\n \"locations\": {\n \"key_0\": {\n \"available\": 20\n },\n \"key_1\": {\n \"available\": 20\n }\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 \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock\",\n \"attributes\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10,\n \"locations\": {\n \"key_0\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n },\n \"key_1\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n },\n \"key_2\": {\n \"available\": 20,\n \"total\": 30,\n \"allocated\": 10\n }\n }\n },\n \"meta\": {\n \"stock_id\": \"00000000-0000-0000-0000-000000000000\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b891ac24-e2bb-4e6b-9437-1123653efa49", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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 \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock\",\n \"attributes\": {\n \"locations\": {\n \"key_0\": {\n \"available\": 20\n },\n \"key_1\": {\n \"available\": 20\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff92493e-330e-4708-ad2d-c9816046d5e4", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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 \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock\",\n \"attributes\": {\n \"locations\": {\n \"key_0\": {\n \"available\": 20\n },\n \"key_1\": {\n \"available\": 20\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No location found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff2914cf-5183-4514-b60c-bdd742462cae", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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 \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock\",\n \"attributes\": {\n \"locations\": {\n \"key_0\": {\n \"available\": 20\n },\n \"key_1\": {\n \"available\": 20\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1346747-1a97-4dbf-a78c-8c9f86625eef", "name": "Delete Stock for Product", "request": { "name": "Delete Stock for Product", "description": { "content": "Deletes the inventory for the specified product. The product inventory is null and is no longer managed by Commerce. If you want to keep managing inventory but have none of the product in stock, set the inventory to `0` instead of deleting the inventory.", "type": "text/plain" }, "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "1be7525e-d680-48f2-b4de-453ead1bd404", "name": "Success. Removes the stock information about the product", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "3f88dcde-353a-4478-bac8-1e8f7624ea63", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b889062-c015-478b-b655-cc00fc56e161", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No location found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac3edf32-b9f9-4344-9a6a-7e55ddabe903", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Transactions", "description": "Methods to allow you to modify and view a products stock via transactions.", "item": [ { "id": "43ea33e6-6f2a-48b9-b73c-dbd420f37cd9", "name": "Get Stock Transactions for Product", "request": { "name": "Get Stock Transactions for Product", "description": { "content": "Returns the transactions recorded for the specified product.", "type": "text/plain" }, "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4105b8a5-981a-4385-8bc7-01bcb299cb8d", "name": "Success. Returns the stock for the given product", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock-transaction\",\n \"attributes\": {\n \"action\": \"allocate\",\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"quantity\": 5,\n \"location\": \"milton-keynes-warehouse\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock-transaction\",\n \"attributes\": {\n \"action\": \"allocate\",\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"quantity\": 5,\n \"location\": \"milton-keynes-warehouse\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "911cb26a-1ff4-4c8d-a92e-d06c78d7f0be", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7b3f551-f476-425c-a738-b53847e74b9b", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No location found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b807aaf-3ca0-4baf-8d0d-f6ca7177c08b", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c38f724-1c9d-4032-8588-dbed0215db91", "name": "Create Stock Transaction on Product", "request": { "name": "Create Stock Transaction on Product", "description": {}, "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock-transaction\",\n \"attributes\": {\n \"action\": \"allocate\",\n \"quantity\": 5,\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"location\": \"milton-keynes-warehouse\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e78a185c-8a33-402f-9841-9d4aa53c953d", "name": "Success. Stock was successfully created for product", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock-transaction\",\n \"attributes\": {\n \"action\": \"allocate\",\n \"quantity\": 5,\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"location\": \"milton-keynes-warehouse\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock-transaction\",\n \"attributes\": {\n \"action\": \"allocate\",\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"quantity\": 5,\n \"location\": \"milton-keynes-warehouse\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d520aee2-691a-4959-8ad0-461d2ade0ac6", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock-transaction\",\n \"attributes\": {\n \"action\": \"allocate\",\n \"quantity\": 5,\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"location\": \"milton-keynes-warehouse\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2224531-2a81-4ea7-a468-f5c1f8e7c671", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock-transaction\",\n \"attributes\": {\n \"action\": \"allocate\",\n \"quantity\": 5,\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"location\": \"milton-keynes-warehouse\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No location found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "055cde8a-0408-47f4-b4d0-c7aacac1be8b", "name": "The request was understood, but could not be processed by the server", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock-transaction\",\n \"attributes\": {\n \"action\": \"allocate\",\n \"quantity\": 5,\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"location\": \"milton-keynes-warehouse\"\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 \"errors\": [\n {\n \"title\": \"Cannot complete request\",\n \"status\": \"422\",\n \"detail\": \"Your request could not be completed due to insufficient stock levels\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a00b25dd-0462-408e-b8ce-cadbaa86fe09", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock-transaction\",\n \"attributes\": {\n \"action\": \"allocate\",\n \"quantity\": 5,\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"location\": \"milton-keynes-warehouse\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47c908b1-66d9-46fb-8bb9-7abb32d6c831", "name": "Get Single Stock Transaction for Product", "request": { "name": "Get Single Stock Transaction for Product", "description": { "content": "Returns the specific transaction with transaction_uuid for product_uuid", "type": "text/plain" }, "url": { "path": [ "inventories", ":product_uuid", "transactions", ":transaction_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "transaction_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b7d2dfe2-2e83-4fc2-ba90-036e70ee0caa", "name": "Success. Returns the stock transaction for the given product", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions", ":transaction_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "transaction_uuid" } ] }, "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 \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"stock-transaction\",\n \"attributes\": {\n \"action\": \"allocate\",\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"quantity\": 5,\n \"location\": \"milton-keynes-warehouse\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55251335-716c-4617-8ef4-894350635e51", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions", ":transaction_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "transaction_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No location found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af9040cc-df06-4b9d-9ec9-cce964f08750", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", ":product_uuid", "transactions", ":transaction_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "product_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the transaction.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "transaction_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Imports", "description": "You can import stock positions for up to 50,000 products in a single operation via an import. This is useful for synchronosing external systems with Elastic Path.\nThe API uses a [**JSONL**](https://jsonlines.org/) file, with one line per product. For each product one specifies the total stock in each location. For example\n\n```\n{\"data\":{\"type\":\"stock\",\"id\":\"b36ba644-6fdc-49b3-9ebb-410ed34908a8\",\"attributes\":{\"locations\":{\"vancouver\":{\"total\":20}}}}}\n{\"data\":{\"type\":\"stock\",\"id\":\"2e5a4c7b-6f88-4aad-a3c2-4d8b29bc32a4\",\"attributes\":{\"locations\":{\"vancouver\":{\"total\":54},\"denver\":{\"total\":1},\"boston\":{\"total\":20},\"portland\":{\"total\":100}}}}}\n```\n\n### Characteristics of Inventories Import\n\nThe Inventories Import API has the following characteristics:\n\n- The Inventories Import API reads the entire file and then updates the inventory.\n\n- Inventories imports are asynchronous and are processed one at a time. You can continue to send import requests, but these are queued. \n\n- If a product in an import does not already exist in the inventories database it will be created.\n", "item": [ { "id": "e4d72385-d356-41e0-8f10-62133c6c15cd", "name": "Import a dataset", "request": { "name": "Import a dataset", "description": {}, "url": { "path": [ "inventories", "imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The JSONL file you want to upload.", "type": "text/plain" }, "key": "import_file", "type": "file" }, { "description": { "content": "A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.", "type": "text/plain" }, "key": "external_ref", "value": "abc123", "type": "text" } ] }, "auth": null }, "response": [ { "id": "dbd1dd48-5860-43af-966d-91c324ad4ace", "name": "Success. The import was started.", "originalRequest": { "url": { "path": [ "inventories", "imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "(Required) The JSONL file you want to upload.", "type": "text/plain" }, "key": "import_file", "type": "file" }, { "description": { "content": "A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.", "type": "text/plain" }, "key": "external_ref", "value": "abc123", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"inventories_import\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"finished_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"records\": {\n \"uploaded\": {\n \"stock\": 50000\n },\n \"imported\": {\n \"stock\": 50000\n }\n }\n },\n \"attributes\": {\n \"status\": \"pending\",\n \"external_ref\": \"abc123\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50de2f7d-4a40-4de7-ae84-dff7d2a2bdec", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "inventories", "imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "(Required) The JSONL file you want to upload.", "type": "text/plain" }, "key": "import_file", "type": "file" }, { "description": { "content": "A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.", "type": "text/plain" }, "key": "external_ref", "value": "abc123", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "764a6341-0667-4997-8526-9b1f412a6d1a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", "imports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "(Required) The JSONL file you want to upload.", "type": "text/plain" }, "key": "import_file", "type": "file" }, { "description": { "content": "A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.", "type": "text/plain" }, "key": "external_ref", "value": "abc123", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de589059-1a4d-4979-965a-448ff8215d94", "name": "List import jobs", "request": { "name": "List import jobs", "description": { "content": "Retrieves a list of all import jobs.\n", "type": "text/plain" }, "url": { "path": [ "inventories", "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b36e0e45-a898-4b8e-8af2-37739177c254", "name": "Success. A list of import jobs is returned.", "originalRequest": { "url": { "path": [ "inventories", "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"inventories_import\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"finished_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"records\": {\n \"uploaded\": {\n \"stock\": 50000\n },\n \"imported\": {\n \"stock\": 50000\n }\n }\n },\n \"attributes\": {\n \"status\": \"pending\",\n \"external_ref\": \"abc123\"\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"inventories_import\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"finished_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"records\": {\n \"uploaded\": {\n \"stock\": 50000\n },\n \"imported\": {\n \"stock\": 50000\n }\n }\n },\n \"attributes\": {\n \"status\": \"pending\",\n \"external_ref\": \"abc123\"\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\",\n \"key_2\": \"http://example.com/articles/1/comments\",\n \"key_3\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d73ffa45-5cfd-47dc-9e8c-5c7a426b8585", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce2022f4-5cd1-4320-ae76-1ab4a1f04fc0", "name": "Get import", "request": { "name": "Get import", "description": { "content": "Retrieves the import job for the specified ID.", "type": "text/plain" }, "url": { "path": [ "inventories", "imports", ":import_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "import_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6da0ca87-773d-42bd-8246-342a8e76bfe2", "name": "Success. The import is returned.", "originalRequest": { "url": { "path": [ "inventories", "imports", ":import_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "import_uuid" } ] }, "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 \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"inventories_import\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"finished_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"records\": {\n \"uploaded\": {\n \"stock\": 50000\n },\n \"imported\": {\n \"stock\": 50000\n }\n }\n },\n \"attributes\": {\n \"status\": \"pending\",\n \"external_ref\": \"abc123\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b92df3ac-fef5-4eb5-91cf-7e12e0c525ff", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "inventories", "imports", ":import_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "import_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec727273-167d-49d8-a28a-06a7bfd8bcc7", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", "imports", ":import_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "import_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No location found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8cfce3a-f100-46d3-baee-02c360ef88ad", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", "imports", ":import_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "import_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10f61d97-6a74-49b6-96e6-10c011976682", "name": "Get import errors", "request": { "name": "Get import errors", "description": { "content": "Retrieves all errors encountered as part of the import. Each error is attributed to a line in the JSONL file \nimported, so for example, if at line 1 in your JSONL you had a stock without locations, there would\nbe a missing key error for locations.\n\nErrors are also ordered by line number ascending, and can be paginated.\n", "type": "text/plain" }, "url": { "path": [ "inventories", "imports", ":import_uuid", "errors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "import_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c876200e-937c-4fc3-b4f0-2b4a631fe295", "name": "Success. The import errors are returned.", "originalRequest": { "url": { "path": [ "inventories", "imports", ":import_uuid", "errors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "import_uuid" } ] }, "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\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"inventories_import_error\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"error\": \"product name cannot be empty\",\n \"field\": \"name\",\n \"line_number\": 123,\n \"external_ref\": \"abc123\"\n }\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"inventories_import_error\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"error\": \"product name cannot be empty\",\n \"field\": \"name\",\n \"line_number\": 123,\n \"external_ref\": \"abc123\"\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1a759cd-c53f-438e-a5ae-56d6c0b30a26", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", "imports", ":import_uuid", "errors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "import_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No location found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9b40e6a-5c0b-4ae5-9f9c-05d484db35ae", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "inventories", "imports", ":import_uuid", "errors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "import_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Locations", "description": "", "item": [ { "id": "a0f04857-bc9f-4482-b347-09d0278a7cd7", "name": "List Locations", "request": { "name": "List Locations", "description": { "content": "Lists all Inventory Locations", "type": "text/plain" }, "url": { "path": [ "inventories", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" }, { "disabled": false, "description": { "content": "Only supported value is `location`. When specified, the results are sorted in ascending order based on the value of the field. For `location`, this means ascending distance from the supplied geolocation. For more information, see [Sorting](/guides/Getting-Started/sorting). For location sorting, `Ep-Geolocation` header must be provided as well. (This can only be one of location)", "type": "text/plain" }, "key": "sort", "value": "location" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Latitude, Longitude representing current location", "type": "text/plain" }, "key": "Ep-Geolocation", "value": "49.2847027,-123.1109329" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3a5728c9-e059-4bfb-adf2-b2145a47bc1f", "name": "Success. A list of locations is returned", "originalRequest": { "url": { "path": [ "inventories", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" }, { "disabled": false, "description": { "content": "Only supported value is `location`. When specified, the results are sorted in ascending order based on the value of the field. For `location`, this means ascending distance from the supplied geolocation. For more information, see [Sorting](/guides/Getting-Started/sorting). For location sorting, `Ep-Geolocation` header must be provided as well. (This can only be one of location)", "type": "text/plain" }, "key": "sort", "value": "location" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Latitude, Longitude representing current location", "type": "text/plain" }, "key": "Ep-Geolocation", "value": "49.2847027,-123.1109329" }, { "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\": \"ebc7652d-bb7d-4359-9a83-78f2998208d9\",\n \"type\": \"inventory_location\",\n \"attributes\": {\n \"name\": \"Milton Keynes Warehouse\",\n \"external_ref\": \"mk-stock-warehouse-walnut-tree\",\n \"slug\": \"milton-keynes-warehouse\",\n \"description\": \"Southern dispatch location for all inventory\",\n \"address\": [\n \"Troughton Supplies\",\n \"38 Pipernel Grove\",\n \"Walnut Tree\",\n \"MK7 4UL\"\n ],\n \"geolocation\": {\n \"lat\": -90,\n \"lon\": 180\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e95a124f-1672-41f5-ada3-337cdc12c0c1", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "inventories", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(location,new-york)" }, { "disabled": false, "description": { "content": "Only supported value is `location`. When specified, the results are sorted in ascending order based on the value of the field. For `location`, this means ascending distance from the supplied geolocation. For more information, see [Sorting](/guides/Getting-Started/sorting). For location sorting, `Ep-Geolocation` header must be provided as well. (This can only be one of location)", "type": "text/plain" }, "key": "sort", "value": "location" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Latitude, Longitude representing current location", "type": "text/plain" }, "key": "Ep-Geolocation", "value": "49.2847027,-123.1109329" }, { "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52aa2b42-c8ba-4b23-a711-7c0751013c1b", "name": "Create a Location", "request": { "name": "Create a Location", "description": { "content": "Creates an Inventory Location", "type": "text/plain" }, "url": { "path": [ "inventories", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Milton Keynes Warehouse\",\n \"slug\": \"milton-keynes-warehouse\",\n \"external_ref\": \"mk-stock-warehouse-walnut-tree\",\n \"description\": \"Southern dispatch location for all inventory\",\n \"address\": [\n \"string\"\n ],\n \"geolocation\": {\n \"lat\": 51.477928,\n \"lon\": -0.001545\n }\n },\n \"type\": \"inventory_location\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d074583b-5e47-4016-897f-9eb586921b77", "name": "Success. The location was created successfully", "originalRequest": { "url": { "path": [ "inventories", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Milton Keynes Warehouse\",\n \"slug\": \"milton-keynes-warehouse\",\n \"external_ref\": \"mk-stock-warehouse-walnut-tree\",\n \"description\": \"Southern dispatch location for all inventory\",\n \"address\": [\n \"string\"\n ],\n \"geolocation\": {\n \"lat\": 51.477928,\n \"lon\": -0.001545\n }\n },\n \"type\": \"inventory_location\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"ebc7652d-bb7d-4359-9a83-78f2998208d9\",\n \"type\": \"inventory_location\",\n \"attributes\": {\n \"name\": \"Milton Keynes Warehouse\",\n \"external_ref\": \"mk-stock-warehouse-walnut-tree\",\n \"slug\": \"milton-keynes-warehouse\",\n \"description\": \"Southern dispatch location for all inventory\",\n \"address\": [\n \"Troughton Supplies\",\n \"38 Pipernel Grove\",\n \"Walnut Tree\",\n \"MK7 4UL\"\n ],\n \"geolocation\": {\n \"lat\": -90,\n \"lon\": 180\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a4f9463-f088-49c0-a139-caf0f89fd327", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "inventories", "locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Milton Keynes Warehouse\",\n \"slug\": \"milton-keynes-warehouse\",\n \"external_ref\": \"mk-stock-warehouse-walnut-tree\",\n \"description\": \"Southern dispatch location for all inventory\",\n \"address\": [\n \"string\"\n ],\n \"geolocation\": {\n \"lat\": 51.477928,\n \"lon\": -0.001545\n }\n },\n \"type\": \"inventory_location\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0db527b-c636-4193-a59c-f12b0ea44d93", "name": "Get a Location", "request": { "name": "Get a Location", "description": { "content": "Get an Inventory Location", "type": "text/plain" }, "url": { "path": [ "inventories", "locations", ":location_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "location_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the location.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0798f4c9-b78b-4e8b-915f-bc70f66b92c5", "name": "Success. The location is returned", "originalRequest": { "url": { "path": [ "inventories", "locations", ":location_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the location.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "location_uuid" } ] }, "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 \"id\": \"ebc7652d-bb7d-4359-9a83-78f2998208d9\",\n \"type\": \"inventory_location\",\n \"attributes\": {\n \"name\": \"Milton Keynes Warehouse\",\n \"external_ref\": \"mk-stock-warehouse-walnut-tree\",\n \"slug\": \"milton-keynes-warehouse\",\n \"description\": \"Southern dispatch location for all inventory\",\n \"address\": [\n \"Troughton Supplies\",\n \"38 Pipernel Grove\",\n \"Walnut Tree\",\n \"MK7 4UL\"\n ],\n \"geolocation\": {\n \"lat\": -90,\n \"lon\": 180\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "751521c6-f049-4f5d-9b53-37cd8d9256d1", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", "locations", ":location_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the location.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "location_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No location found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a4cf510c-e50b-4484-a456-df313feabbcb", "name": "Update a Location", "request": { "name": "Update a Location", "description": { "content": "Updates an Inventory Location", "type": "text/plain" }, "url": { "path": [ "inventories", "locations", ":location_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "location_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the location.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"inventory_location\",\n \"attributes\": {\n \"name\": \"Milton Keynes Warehouse\",\n \"external_ref\": \"mk-stock-warehouse-walnut-tree\",\n \"slug\": \"milton-keynes-warehouse\",\n \"description\": \"Southern dispatch location for all inventory\",\n \"address\": [\n \"string\"\n ],\n \"geolocation\": {\n \"lat\": 51.477928,\n \"lon\": -0.001545\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5fcedd88-0ec8-42a4-9fc0-8856503a27a6", "name": "Success. The location was updated successfully", "originalRequest": { "url": { "path": [ "inventories", "locations", ":location_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the location.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "location_uuid" } ] }, "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 \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"inventory_location\",\n \"attributes\": {\n \"name\": \"Milton Keynes Warehouse\",\n \"external_ref\": \"mk-stock-warehouse-walnut-tree\",\n \"slug\": \"milton-keynes-warehouse\",\n \"description\": \"Southern dispatch location for all inventory\",\n \"address\": [\n \"string\"\n ],\n \"geolocation\": {\n \"lat\": 51.477928,\n \"lon\": -0.001545\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 \"id\": \"ebc7652d-bb7d-4359-9a83-78f2998208d9\",\n \"type\": \"inventory_location\",\n \"attributes\": {\n \"name\": \"Milton Keynes Warehouse\",\n \"external_ref\": \"mk-stock-warehouse-walnut-tree\",\n \"slug\": \"milton-keynes-warehouse\",\n \"description\": \"Southern dispatch location for all inventory\",\n \"address\": [\n \"Troughton Supplies\",\n \"38 Pipernel Grove\",\n \"Walnut Tree\",\n \"MK7 4UL\"\n ],\n \"geolocation\": {\n \"lat\": -90,\n \"lon\": 180\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "472bfa38-a7a8-4152-a0ae-e23b3b4ff3fd", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "inventories", "locations", ":location_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the location.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "location_uuid" } ] }, "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 \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"inventory_location\",\n \"attributes\": {\n \"name\": \"Milton Keynes Warehouse\",\n \"external_ref\": \"mk-stock-warehouse-walnut-tree\",\n \"slug\": \"milton-keynes-warehouse\",\n \"description\": \"Southern dispatch location for all inventory\",\n \"address\": [\n \"string\"\n ],\n \"geolocation\": {\n \"lat\": 51.477928,\n \"lon\": -0.001545\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"Your request was invalid\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49498087-fa83-414d-90e6-e69b97ddc36d", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "inventories", "locations", ":location_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the location.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "location_uuid" } ] }, "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 \"data\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"inventory_location\",\n \"attributes\": {\n \"name\": \"Milton Keynes Warehouse\",\n \"external_ref\": \"mk-stock-warehouse-walnut-tree\",\n \"slug\": \"milton-keynes-warehouse\",\n \"description\": \"Southern dispatch location for all inventory\",\n \"address\": [\n \"string\"\n ],\n \"geolocation\": {\n \"lat\": 51.477928,\n \"lon\": -0.001545\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No location found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd5708ae-b80f-42c3-960a-a39ebe5506c0", "name": "Delete a Location", "request": { "name": "Delete a Location", "description": { "content": "Delete an Inventory Location", "type": "text/plain" }, "url": { "path": [ "inventories", "locations", ":location_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "location_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the location.", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "b5812506-bd21-410e-a522-0cc58769d596", "name": "Success. The location is deleted", "originalRequest": { "url": { "path": [ "inventories", "locations", ":location_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the location.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "location_uuid" } ] }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Gateways", "description": "", "item": [ { "id": "0accc54d-e786-4876-b00f-b5628a0f693a", "name": "Get all Gateways", "request": { "name": "Get all Gateways", "description": { "content": "Retrieves all gateways.", "type": "text/plain" }, "url": { "path": [ "v2", "gateways" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3b3f5263-6480-4590-b3b4-646af6f31d5b", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "gateways" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"enabled\": true,\n \"login\": \"string\",\n \"name\": \"{gatewayName}\",\n \"type\": \"gateway\",\n \"password\": \"string\",\n \"signature\": \"string\",\n \"slug\": \"{gatewaySlug}\",\n \"test\": false\n },\n {\n \"enabled\": true,\n \"login\": \"string\",\n \"name\": \"{gatewayName}\",\n \"type\": \"gateway\",\n \"password\": \"string\",\n \"signature\": \"string\",\n \"slug\": \"{gatewaySlug}\",\n \"test\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44f7a16e-42a9-49c3-b808-1456ce6d31f7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "gateways" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6fc78690-f48f-455d-b713-a6dd79376c3e", "name": "Get a Gateway", "request": { "name": "Get a Gateway", "description": { "content": "Retrieves the specified gateway.", "type": "text/plain" }, "url": { "path": [ "v2", "gateways", ":gatewaySlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "adyen", "key": "gatewaySlug", "disabled": false, "description": { "content": "(Required) The slug of the gateway. (This can only be one of manual,braintree,stripe,stripe_payment_intents,elastic_path_payments_stripe,paypal_express_checkout,adyen,authorize_net,card_connect,cyber_source)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6603191e-7532-4260-90d8-4dbfbfb31b45", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "gateways", ":gatewaySlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the gateway. (This can only be one of manual,braintree,stripe,stripe_payment_intents,elastic_path_payments_stripe,paypal_express_checkout,adyen,authorize_net,card_connect,cyber_source)", "type": "text/plain" }, "type": "any", "value": "adyen", "key": "gatewaySlug" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"string\",\n \"name\": \"{gatewayName}\",\n \"type\": \"gateway\",\n \"password\": \"string\",\n \"signature\": \"string\",\n \"slug\": \"{gatewaySlug}\",\n \"test\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b3ace7d-46ce-4017-8263-762eabe1e9e7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "gateways", ":gatewaySlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The slug of the gateway. (This can only be one of manual,braintree,stripe,stripe_payment_intents,elastic_path_payments_stripe,paypal_express_checkout,adyen,authorize_net,card_connect,cyber_source)", "type": "text/plain" }, "type": "any", "value": "adyen", "key": "gatewaySlug" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d10abb75-7c71-49b7-90c2-c9241808bde7", "name": "Update Manual Gateway", "request": { "name": "Update Manual Gateway", "description": { "content": "This endpoint allows you update the manual gateway.", "type": "text/plain" }, "url": { "path": [ "v2", "gateways", "manual" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8cd97311-acdd-4cb0-a9ce-d80b7579e952", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "gateways", "manual" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"enabled\": true,\n \"name\": \"Manual\",\n \"slug\": \"manual\",\n \"type\": \"gateway\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b92fc146-0aeb-4a25-a2ae-829fb695608a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "gateways", "manual" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "373f03a7-adcd-4fef-a13b-6dbf8839c399", "name": "Update Braintree Gateway", "request": { "name": "Update Braintree Gateway", "description": { "content": "Use this endpoint to configure Braintree.", "type": "text/plain" }, "url": { "path": [ "v2", "gateways", "braintree" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"environment\": \"sandbox\",\n \"merchant_id\": \"{{braintreeMerchantId}}\",\n \"private_key\": \"{{braintreePrivateKey}}\",\n \"public_key\": \"{{braintreePublicKey}}\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "db307444-7809-43c3-9a02-c2fc27a049b0", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "gateways", "braintree" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"environment\": \"sandbox\",\n \"merchant_id\": \"{{braintreeMerchantId}}\",\n \"private_key\": \"{{braintreePrivateKey}}\",\n \"public_key\": \"{{braintreePublicKey}}\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"enabled\": true,\n \"name\": \"Braintree\",\n \"environment\": \"sandbox\",\n \"merchant_id\": \"{{braintreeMerchantId}}\",\n \"private_key\": \"{{braintreePrivateKey}}\",\n \"public_key\": \"{{braintreePublicKey}}\",\n \"slug\": \"braintree\",\n \"type\": \"gateway\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "216ded62-a0f7-4536-9104-6448a80b2417", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "gateways", "braintree" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"environment\": \"sandbox\",\n \"merchant_id\": \"{{braintreeMerchantId}}\",\n \"private_key\": \"{{braintreePrivateKey}}\",\n \"public_key\": \"{{braintreePublicKey}}\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b68dc01-0d19-4e6a-933a-a1847f725ffe", "name": "Update Stripe Gateway", "request": { "name": "Update Stripe Gateway", "description": { "content": "Use this endpoint to configure Stripe.", "type": "text/plain" }, "url": { "path": [ "v2", "gateways", "stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"{{stripeToken}}\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6b6aa348-b192-466c-9c5c-2764ef193467", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "gateways", "stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"{{stripeToken}}\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"{{stripeToken}}\",\n \"name\": \"Stripe\",\n \"slug\": \"stripe\",\n \"type\": \"gateway\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "057850c5-26e8-467f-b857-fabde21b8a84", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "gateways", "stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"{{stripeToken}}\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd5344e3-f4a3-476d-afab-4b0954aec7db", "name": "Update Stripe Payment Intents Gateway", "request": { "name": "Update Stripe Payment Intents Gateway", "description": { "content": "Use this endpoint to configure Stripe Payment Intents.", "type": "text/plain" }, "url": { "path": [ "v2", "gateways", "stripe_payment_intents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"{{stripeLoginToken}}\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "11c73542-8ea0-41fe-b142-5afd1a1c697f", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "gateways", "stripe_payment_intents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"{{stripeLoginToken}}\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"{{stripeLoginToken}}\",\n \"name\": \"Stripe Payment Intents\",\n \"slug\": \"stripe_payment_intents\",\n \"type\": \"gateway\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94b8c8ab-399e-49e1-bc78-fee90990cf06", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "gateways", "stripe_payment_intents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"{{stripeLoginToken}}\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5faf183d-db64-4cd6-9f3e-224d36ae7a3c", "name": "Update Elastic Path Payments Powered by Stripe", "request": { "name": "Update Elastic Path Payments Powered by Stripe", "description": { "content": "Use this endpoint to configure Elastic Path Payments Powered by Stripe in Commerce. \n\n:::note\n\nYou can contact Elastic Path sales or [customer success team](mailto:customersuccess@elasticpath.com) to get more information about Elastic Path Payments Powered by Stripe and to check whether it will work for you.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "gateways", "elastic_path_payments_stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"stripe_account\": \"{{stripeAccountId}}\",\n \"test\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "cb6353ae-2f2c-46dd-9ebd-3d5f86ba7781", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "gateways", "elastic_path_payments_stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"stripe_account\": \"{{stripeAccountId}}\",\n \"test\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"enabled\": true,\n \"stripe_account\": \"{{stripeAccountId}}\",\n \"name\": \"Elastic Path Payments powered by Stripe\",\n \"test\": true,\n \"slug\": \"elastic_path_payments_stripe\",\n \"type\": \"gateway\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8235f4a-83b8-4be0-b6b7-c900468cb7d3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "gateways", "elastic_path_payments_stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"stripe_account\": \"{{stripeAccountId}}\",\n \"test\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be410242-e637-4cc2-b3f6-f5c1986d8693", "name": "Update PayPal Express Checkout", "request": { "name": "Update PayPal Express Checkout", "description": { "content": "Use this endpoint to configure PayPal Express Checkout. \n:::note\n\nTo learn more about PayPal Express Checkout and check whether it will work for you, contact your sales or [customer success team](mailto:customersuccess@elasticpath.com).\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "gateways", "paypal_express_checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"payer_id\": \"{{merchant account id}}\",\n \"test\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d9451f69-4bb0-4ab7-96be-8407cf93f843", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "gateways", "paypal_express_checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"payer_id\": \"{{merchant account id}}\",\n \"test\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"enabled\": true,\n \"payer_id\": \"{{merchant account id}}\",\n \"name\": \"PayPal Express Checkout\",\n \"test\": true,\n \"slug\": \"paypal_express_checkout\",\n \"type\": \"gateway\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a533563-39c4-4c87-9285-e91ef9541011", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "gateways", "paypal_express_checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"payer_id\": \"{{merchant account id}}\",\n \"test\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6fe6c4f1-7871-4c3c-9140-2ea8e0f586b1", "name": "Update Adyen Gateway", "request": { "name": "Update Adyen Gateway", "description": { "content": "Use this endpoint to configure Adyen.", "type": "text/plain" }, "url": { "path": [ "v2", "gateways", "adyen" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"merchant_account\": \"MyCompanyECOM\",\n \"username\": \"ws@Company.MyCompany\",\n \"password\": \"xxx\",\n \"test\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7e8ea219-fa63-48ad-8cce-d3804a3bfba9", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "gateways", "adyen" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"merchant_account\": \"MyCompanyECOM\",\n \"username\": \"ws@Company.MyCompany\",\n \"password\": \"xxx\",\n \"test\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"string\",\n \"name\": \"{gatewayName}\",\n \"type\": \"gateway\",\n \"password\": \"string\",\n \"signature\": \"string\",\n \"slug\": \"{gatewaySlug}\",\n \"test\": false,\n \"merchant_account\": \"MyCompanyECOM\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2212c98f-a64b-49d1-ad3c-a4c7aca322d4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "gateways", "adyen" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"merchant_account\": \"MyCompanyECOM\",\n \"username\": \"ws@Company.MyCompany\",\n \"password\": \"xxx\",\n \"test\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4381c2b4-0a6a-4cca-8616-7a4b5849de43", "name": "Update Authorize.net Gateway", "request": { "name": "Update Authorize.net Gateway", "description": { "content": "\nUse this endpoint to configure Authorize.net.\n\n:::note\nThe credentials used for a test account may differ from those used for a live account. When configuring the payment gateway with your credentials and setting `test` to `true`, the system allows you to test various Authorize.net payment interactions to ensure everything works as expected. Once you are ready to go live, update `test` as `false` to direct requests to the live endpoints instead of the test account. Additionally, ensure that you switch to the credentials for the live account when making this change. To access your sandbox environment, see [Authorize.net Sandbox account](https://developer.authorize.net/hello_world/sandbox.html).\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "gateways", "authorize_net" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"login\": \"xxx\",\n \"password\": \"xxx\",\n \"slug\": \"authorize_net\",\n \"enabled\": true,\n \"test\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "672c4471-cc57-40e9-ae51-a49d0cd60215", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "gateways", "authorize_net" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"login\": \"xxx\",\n \"password\": \"xxx\",\n \"slug\": \"authorize_net\",\n \"enabled\": true,\n \"test\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"string\",\n \"name\": \"{gatewayName}\",\n \"type\": \"gateway\",\n \"password\": \"authorize-net-transaction-key\",\n \"signature\": \"string\",\n \"slug\": \"{gatewaySlug}\",\n \"test\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05e09482-fe64-41e8-82d8-e82f41c8186c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "gateways", "authorize_net" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"login\": \"xxx\",\n \"password\": \"xxx\",\n \"slug\": \"authorize_net\",\n \"enabled\": true,\n \"test\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d5fb2bc-2614-46bf-bf01-88c002503fa7", "name": "Update CardConnect Gateway", "request": { "name": "Update CardConnect Gateway", "description": { "content": "Use this endpoint to configure CardConnect.", "type": "text/plain" }, "url": { "path": [ "v2", "gateways", "card_connect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"merchant_id\": \"xxx\",\n \"username\": \"xxx\",\n \"password\": \"xxx\",\n \"test\": false,\n \"enabled\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bf059046-4e9f-41dd-a58f-f140ec3860b6", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "gateways", "card_connect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"merchant_id\": \"xxx\",\n \"username\": \"xxx\",\n \"password\": \"xxx\",\n \"test\": false,\n \"enabled\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"string\",\n \"name\": \"{gatewayName}\",\n \"type\": \"gateway\",\n \"password\": \"string\",\n \"signature\": \"string\",\n \"slug\": \"{gatewaySlug}\",\n \"test\": false,\n \"merchant_id\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6372544-9835-4189-85ca-812f71667bce", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "gateways", "card_connect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"merchant_id\": \"xxx\",\n \"username\": \"xxx\",\n \"password\": \"xxx\",\n \"test\": false,\n \"enabled\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "446961d2-224f-4a3a-980c-447b8940ad0f", "name": "Update CyberSource Gateway", "request": { "name": "Update CyberSource Gateway", "description": { "content": "Use this endpoint to configure CyberSource.", "type": "text/plain" }, "url": { "path": [ "v2", "gateways", "cyber_source" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"xxx\",\n \"password\": \"xxx\",\n \"test\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "877ece05-2d6b-4e83-a84d-7bec35370ca7", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "gateways", "cyber_source" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"xxx\",\n \"password\": \"xxx\",\n \"test\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"cybersource-merchant-id\",\n \"name\": \"{gatewayName}\",\n \"type\": \"gateway\",\n \"password\": \"cybersource SOAP key\",\n \"signature\": \"string\",\n \"slug\": \"{gatewaySlug}\",\n \"test\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e091fc31-52b3-4a93-8730-05c63b0fdcc6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "gateways", "cyber_source" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"enabled\": true,\n \"login\": \"xxx\",\n \"password\": \"xxx\",\n \"test\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Built-in Roles", "description": "Built-in Roles represent the various personas supported in Commerce. Some Roles pertain to store management and can be assigned to users through Commerce Manager, while others represent customers who shop at the store.\n", "item": [ { "id": "d69ae4e2-6fff-4fe1-89fe-c2b20317f6bb", "name": "List Built-in Roles", "request": { "name": "List Built-in Roles", "description": { "content": "Retrieves a list of Built-in Roles\n", "type": "text/plain" }, "url": { "path": [ "v2", "permissions", "built-in-roles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ca660b5f-a689-4d7f-b767-6f9d08b100fb", "name": "List of Built-in Roles", "originalRequest": { "url": { "path": [ "v2", "permissions", "built-in-roles" ], "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" } ], "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"cm_user_assignable\": false,\n \"links\": {\n \"self\": null\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"cm_user_assignable\": true,\n \"links\": {\n \"self\": null\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e2cec8b-1a78-4e7d-b541-af5dd6b5d000", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "permissions", "built-in-roles" ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Invalid filter: unknown field [version] specified in search filter, allowed fields are [api_type created_at description id name slug updated_at]\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b6a575f-95f9-44a6-81a1-1984311e9543", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "permissions", "built-in-roles" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0fc0041e-0fb1-4129-9ec9-2628a2aeaccf", "name": "Get a Built-in Role", "request": { "name": "Get a Built-in Role", "description": { "content": "Get a Built-in Role", "type": "text/plain" }, "url": { "path": [ "v2", "permissions", "built-in-roles", ":built-in-role-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "it-developer", "key": "built-in-role-id", "disabled": false, "description": { "content": "(Required) The ID of the Built-In Role.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6ff9d3be-8111-475f-89be-d84a73af52a2", "name": "A Built-in Role", "originalRequest": { "url": { "path": [ "v2", "permissions", "built-in-roles", ":built-in-role-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Built-In Role.", "type": "text/plain" }, "type": "any", "value": "it-developer", "key": "built-in-role-id" } ] }, "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 \"id\": \"string\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"cm_user_assignable\": true,\n \"links\": {\n \"self\": \"https://ezPHXhVscKpowaRacPZIXvjusVpA.mdhf-YIeMRHjb25D\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b18df54-5257-4b89-a734-82189d31f3cd", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "permissions", "built-in-roles", ":built-in-role-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Built-In Role.", "type": "text/plain" }, "type": "any", "value": "it-developer", "key": "built-in-role-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "393e4a96-85c3-4d22-ad2b-ae3a0153e900", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "permissions", "built-in-roles", ":built-in-role-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Built-In Role.", "type": "text/plain" }, "type": "any", "value": "it-developer", "key": "built-in-role-id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Custom API Role Policies", "description": "A Custom API Role Policy defines the level of access a role has to a Custom API. By default, administrative roles like **Store Admin** or **Org Admin** have full access to all Custom APIs. To grant access to other roles, a policy must be created for that specific role and Custom API.\n\nBelow are the permissions that can be assigned to a role:\n\n| Permission | Description |\n|------------|------------------------------------------|\n| **Create** | Create a Custom API Entry. |\n| **List** | Retrieve a list of Custom API Entries. |\n| **Read** | Get a Custom API Entry. |\n| **Update** | Update a Custom API Entry. |\n| **Delete** | Delete a Custom API Entry. |\n", "item": [ { "id": "c52f3b41-6e27-4a4b-8065-7f4228f9cc02", "name": "Create A Custom API Role Policy", "request": { "name": "Create A Custom API Role Policy", "description": { "content": "Create A Custom API Role Policy", "type": "text/plain" }, "url": { "path": [ "v2", "permissions", "custom-api-role-policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_api_role_policy\",\n \"create\": true,\n \"list\": false,\n \"read\": true,\n \"update\": false,\n \"delete\": true,\n \"relationships\": {\n \"custom_api\": {\n \"data\": {\n \"id\": \"fded1d2a-8bb8-48b6-86a5-9eb05cc8626a\",\n \"type\": \"custom_api\"\n }\n },\n \"role\": {\n \"data\": {\n \"id\": \"it-developer\",\n \"type\": \"built_in_role\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8e7e8c38-2e1d-468f-a6c0-486eba32dd90", "name": "A Custom API Role Policy", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_api_role_policy\",\n \"create\": true,\n \"list\": false,\n \"read\": true,\n \"update\": false,\n \"delete\": true,\n \"relationships\": {\n \"custom_api\": {\n \"data\": {\n \"id\": \"fded1d2a-8bb8-48b6-86a5-9eb05cc8626a\",\n \"type\": \"custom_api\"\n }\n },\n \"role\": {\n \"data\": {\n \"id\": \"it-developer\",\n \"type\": \"built_in_role\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"69e3891a-c6c7-96bd-0914-589dd12dad90\",\n \"type\": \"string\",\n \"create\": false,\n \"list\": true,\n \"read\": true,\n \"update\": true,\n \"delete\": true,\n \"links\": {\n \"self\": \"https://PYezzshXl.atwJg.SZ8wiJjTuAhdRSIQWv\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n },\n \"relationships\": {\n \"custom_api\": {\n \"data\": {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"string\"\n }\n },\n \"role\": {\n \"data\": {\n \"id\": \"it-developer\",\n \"type\": \"string\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e795addf-d269-4741-9db0-6ba50688074c", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_api_role_policy\",\n \"create\": true,\n \"list\": false,\n \"read\": true,\n \"update\": false,\n \"delete\": true,\n \"relationships\": {\n \"custom_api\": {\n \"data\": {\n \"id\": \"fded1d2a-8bb8-48b6-86a5-9eb05cc8626a\",\n \"type\": \"custom_api\"\n }\n },\n \"role\": {\n \"data\": {\n \"id\": \"it-developer\",\n \"type\": \"built_in_role\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbf65a90-7003-4c69-b6a5-b1d0a451ac3e", "name": "Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_api_role_policy\",\n \"create\": true,\n \"list\": false,\n \"read\": true,\n \"update\": false,\n \"delete\": true,\n \"relationships\": {\n \"custom_api\": {\n \"data\": {\n \"id\": \"fded1d2a-8bb8-48b6-86a5-9eb05cc8626a\",\n \"type\": \"custom_api\"\n }\n },\n \"role\": {\n \"data\": {\n \"id\": \"it-developer\",\n \"type\": \"built_in_role\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"custom_api with the given api_type already exists\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "940205fe-1390-44d4-9beb-a5c87a0c6bb7", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_api_role_policy\",\n \"create\": true,\n \"list\": false,\n \"read\": true,\n \"update\": false,\n \"delete\": true,\n \"relationships\": {\n \"custom_api\": {\n \"data\": {\n \"id\": \"fded1d2a-8bb8-48b6-86a5-9eb05cc8626a\",\n \"type\": \"custom_api\"\n }\n },\n \"role\": {\n \"data\": {\n \"id\": \"it-developer\",\n \"type\": \"built_in_role\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32cdef9a-4cbe-433e-8f3d-accb4dc69c0e", "name": "List Custom API Role Policies", "request": { "name": "List Custom API Role Policies", "description": { "content": "Retrieves a list of Custom API Role Policies\n\n## Filtering\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) Custom API Role Policies:\n\n| Attribute | Operators | Example |\n|------------------|-------------------------------|----------------------------------------------------------|\n| `id` | `lt`,`le`,`eq`,`gt`,`ge`,`in` | `eq(id,3fa85f64-5717-4562-b3fc-2c963f66afa6)` |\n| `created_at` | `lt`,`le`,`eq`,`gt`,`ge` | `ge(created_at,2024-04-29T00:00:00.000Z)` |\n| `updated_at` | `lt`,`le`,`eq`,`gt`,`ge` | `le(updated_at,2024-04-29T00:00:00.000Z)` |\n| `custom_api_id` | `eq` | `eq(custom_api_id,fded1d2a-8bb8-48b6-86a5-9eb05cc8626a)` |\n| `role_id` | `eq` | `eq(role_id,it-developer)` |\n\n## Sorting\nThe following attributes are available for sorting. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with `-`, for example, `-updated_at`. The default sort order is `created_at` in descending order.\n- `id`\n- `created_at`\n- `updated_at`\n", "type": "text/plain" }, "url": { "path": [ "v2", "permissions", "custom-api-role-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2861" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "2728" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom API Role Policies will be returned. (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "49c062f3-0d5c-423e-9569-204a0ad1d19d", "name": "List of Custom API Role Policies", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2861" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "2728" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom API Role Policies will be returned. (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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\": \"710c48d0-29a1-7905-51a2-773d1cb99fbc\",\n \"type\": \"string\",\n \"create\": true,\n \"list\": true,\n \"read\": true,\n \"update\": false,\n \"delete\": false,\n \"links\": {\n \"self\": null\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n },\n \"relationships\": {\n \"custom_api\": {\n \"data\": {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"string\"\n }\n },\n \"role\": {\n \"data\": {\n \"id\": \"it-developer\",\n \"type\": \"string\"\n }\n }\n }\n },\n {\n \"id\": \"b8364fe8-8cea-bcc1-4be5-29d4e0612d71\",\n \"type\": \"string\",\n \"create\": false,\n \"list\": false,\n \"read\": true,\n \"update\": false,\n \"delete\": true,\n \"links\": {\n \"self\": null\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n },\n \"relationships\": {\n \"custom_api\": {\n \"data\": {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"string\"\n }\n },\n \"role\": {\n \"data\": {\n \"id\": \"it-developer\",\n \"type\": \"string\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 7751\n },\n \"page\": {\n \"limit\": 100,\n \"offset\": 0,\n \"current\": 1,\n \"total\": 1\n }\n },\n \"links\": {\n \"current\": \"http://MvHiICeTwNPxKqV.agshMcYf9JFFALhV6Gi4y,4vWg3\",\n \"first\": \"http://dhBADCesmwBEZQqpaTYoNbdifjL.snmhTkvW,0iR1DqBVu\",\n \"last\": \"http://RSeQnRMcKyUALiRmkOjWruhDgJfty.wjMIxEl-QT3w3gb2kxGfsJOBe25kpg--syaVmoniAeWzLOacUh96Oj-OTMGeF\",\n \"next\": null,\n \"prev\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57649069-95ab-410d-8e98-53273858b4ae", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2861" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "2728" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom API Role Policies will be returned. (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"Invalid filter: unknown field [version] specified in search filter, allowed fields are [api_type created_at description id name slug updated_at]\",\n \"status\": \"400\",\n \"title\": \"Bad Request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1f645e6-f8c9-44a3-807a-857b1b55544c", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2861" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "2728" }, { "disabled": false, "description": { "content": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Specifies the order in which Custom API Role Policies will be returned. (This can only be one of id,-id,created_at,-created_at,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86c62d6b-15ab-4cd5-a687-1e6ac1a39e6d", "name": "Get a Custom API Role Policy", "request": { "name": "Get a Custom API Role Policy", "description": { "content": "Get A Custom API Role Policy", "type": "text/plain" }, "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id", "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "597170e7-68c0-42ff-995d-8dc42ca9373b", "name": "A Custom API Role Policy", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id" } ] }, "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 \"id\": \"69e3891a-c6c7-96bd-0914-589dd12dad90\",\n \"type\": \"string\",\n \"create\": false,\n \"list\": true,\n \"read\": true,\n \"update\": true,\n \"delete\": true,\n \"links\": {\n \"self\": \"https://PYezzshXl.atwJg.SZ8wiJjTuAhdRSIQWv\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n },\n \"relationships\": {\n \"custom_api\": {\n \"data\": {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"string\"\n }\n },\n \"role\": {\n \"data\": {\n \"id\": \"it-developer\",\n \"type\": \"string\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92334f17-44a8-420d-84e5-06d6eefeea74", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "779e4a2e-2e1e-490f-a758-ac380ab94181", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2f522ba-dea1-493d-adaa-c7515a87fa8e", "name": "Update a Custom API Role Policy", "request": { "name": "Update a Custom API Role Policy", "description": { "content": "Update A Custom API Role Policy", "type": "text/plain" }, "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id", "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_api_role_policy\",\n \"create\": false,\n \"list\": false,\n \"read\": false,\n \"update\": false,\n \"delete\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "85424762-cad2-4f02-bc1c-eb814cd785a9", "name": "A Custom API Role Policy", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id" } ] }, "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 \"data\": {\n \"type\": \"custom_api_role_policy\",\n \"create\": false,\n \"list\": false,\n \"read\": false,\n \"update\": false,\n \"delete\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"69e3891a-c6c7-96bd-0914-589dd12dad90\",\n \"type\": \"string\",\n \"create\": false,\n \"list\": true,\n \"read\": true,\n \"update\": true,\n \"delete\": true,\n \"links\": {\n \"self\": \"https://PYezzshXl.atwJg.SZ8wiJjTuAhdRSIQWv\"\n },\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244Z\"\n }\n },\n \"relationships\": {\n \"custom_api\": {\n \"data\": {\n \"id\": \"652e39d8-d613-493e-8c20-fef99ad6327a\",\n \"type\": \"string\"\n }\n },\n \"role\": {\n \"data\": {\n \"id\": \"it-developer\",\n \"type\": \"string\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35532483-3e13-4c0e-a5bb-bf79c5f3c173", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id" } ] }, "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 \"data\": {\n \"type\": \"custom_api_role_policy\",\n \"create\": false,\n \"list\": false,\n \"read\": false,\n \"update\": false,\n \"delete\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e23d362-f2cd-4482-a5eb-fec3e117e7b2", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id" } ] }, "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 \"data\": {\n \"type\": \"custom_api_role_policy\",\n \"create\": false,\n \"list\": false,\n \"read\": false,\n \"update\": false,\n \"delete\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0c224bb-9a01-4dc8-8f81-d99651143391", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id" } ] }, "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 \"data\": {\n \"type\": \"custom_api_role_policy\",\n \"create\": false,\n \"list\": false,\n \"read\": false,\n \"update\": false,\n \"delete\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d86de406-b472-4312-b961-a52667cae9c9", "name": "Delete a Custom API Role Policy", "request": { "name": "Delete a Custom API Role Policy", "description": { "content": "Delete A Custom API Role Policy", "type": "text/plain" }, "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id", "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "e6cd2ae8-b49e-406a-81d2-de26293cd684", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id" } ] }, "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": "5bf521de-40b3-4df4-a3c4-a6edb74341ea", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"The field 'name' is required.\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aff9f06d-2b20-4556-86d7-2683e13abd7b", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Not found\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9597643-2df0-4562-9cc4-346eec75f717", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "permissions", "custom-api-role-policies", ":custom-api-role-policy-id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the Custom API Role Policy.", "type": "text/plain" }, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "custom-api-role-policy-id" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Products", "description": "```mdx-code-block\nimport ProductsOverview from '/docs/partials/pxm/products/productsoverview.mdx';\nimport ProductTypes from '/docs/partials/pxm/products/types.mdx';\nimport ProductTags from '/docs/partials/pxm/products/tags.mdx';\nimport PersonalProducts from '/docs/partials/pxm/products/personalizing.mdx';\nimport ProductCatalogs from '/docs/partials/pxm/products/catalogs.mdx';\nimport Overview from \"/docs/partials/pxm/bundles/bundles.mdx\";\nimport ComponentOptions from \"/docs/partials/pxm/bundles/components.mdx\";\nimport BundlePricing from \"/docs/partials/pxm/bundles/bundlepricing.mdx\";\nimport DynamicBundles from \"/docs/partials/pxm/bundles/dynamic.mdx\";\nimport BundlesBundles from \"/docs/partials/pxm/bundles/bundlesof.mdx\";\n\n\n\n### Product Types\n\n\n\n### Personalizing Products\n\n\n\n### Products and Catalog Releases\n\n\n\n### Bundles\n\n\n\n### Bundle Components and Options\n\n\n\n### Bundle Pricing\n\n\n\n### Dynamic Bundles\n\n\n\n#### Creating Dynamic Bundles: An Overview\n\nThe following steps are an overview of how to use dynamic bundles.\n\n1. Create your products using [**create a product**](/docs/api/pxm/products/create-product).\n1. Create a bundle using [**create a bundle**](/docs/api/pxm/products/create-product).\n1. Specify minimum and/or maximum values for the number of product options that can be selected within the bundle. For example, if you want the shopper to select exactly 4 out of 10 options, set both the minimum and maximum values to 4 for each of the 10 product options.\n1. For each product option in the bundle, specify if it is a default option by adding `\"default\": true` to the product options that you want to be pre-selected for the shopper.\n1. Publish the bundle to your catalog using the [Publish a catalog](/docs/api/pxm/catalog/publish-release) endpoint so you can display the products to your shoppers in your storefront.\n1. When a shopper interacts with the bundle on your storefront, they can select the products they want from the list of options. Use the [configure a shopper bundle](/docs/api/pxm/catalog/configure-by-context-product) endpoint to capture the shoppers selections. This updates the `bundle_configuration` with the product options chosen by a shopper.\n1. Once a shopper has configured their bundle, use the add a product to a cart endpoint to add the selected bundle to the shopper’s cart.\n1. When the shopper proceeds to checkout, the selected product options from the bundle are included in the order.\n\n### Bundles of Bundles\n\n\n\n#### Creating Bundles of Bundles: An Overview\n\nTo create a bundle of bundles, simply add a bundle as a component to another bundle.\n\n1. Create your products using [**create a product**](/docs/api/pxm/products/create-product).\n1. Create all your child bundles using [**create a bundle**](/docs/api/pxm/products/create-product).\n1. [**Create a parent bundle**](/docs/api/pxm/products/create-product) and specify the product ID of your child bundle as an option of a component in your bundle. You cannot have more than 1500 options in a bundle.\n```\n", "item": [ { "id": "e545a13e-8931-4075-ab62-9c098d907cd7", "name": "Create a product or bundle", "request": { "name": "Create a product or bundle", "description": { "content": "Creates a product or bundle with the attributes that are defined in the body.\n\n#### Product Types\n\nProduct Experience Manager automatically assigns types to the products you create. You can filter on product types. Product types can also be used in catalogs. For example, in your catalog, you can filter on `parent` so that only your parent products are displayed in your storefront. \n\nSee [**Product Types**](/docs/api/pxm/products/products#product-types).\n\n#### Product Tags\n\nYou can use product tags to store or assign a key word against a product or service that you sell in your store. The product tag can then be used to describe or label that product. Product tags represent similarities between products who do not share the same attributes. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. \n\nSee [**Product Tags**](/docs/api/pxm/products/product-tags).\n\n#### Personalizing Products\n\nYou can allow your shoppers to add custom text to a product when adding product items to their carts. This is useful, for example, if you have a product like a T-shirt that can be personalized, or you sell greetings cards that can be printed with your shoppers personalized messages. You can do this by configuring the `custom_inputs` attribute.\n\nWhen configuring the `custom_inputs` attribute:\n\n- You can rename `input` to something more representative of the input that shoppers are adding, for example, `message` or `front`.\n- `name` is the name that is displayed in your storefront.\n- You can add validation rules. For example, the input field must be a `string` and/or up to 255 characters in length. The limit is 255 characters.\n- You can specify if the input field is required.\n\n#### Curating Products\n\nYou can curate the products in a node. Product curation allows you to promote specific products within each node of your hierarchies, enabling you to create unique product collections in your storefront. For example, you may find you have an abundance of cotton T-Shirts and you want to promote these products to the top of the product list. When a shopper navigates to T-shirts, the cotton T-Shirts are displayed first. See [**Update a node**](/docs/api/pxm/products/update-node).\n\n#### Bundles\n\nWith Product Experience Manager, you can use the products API to create and manage bundles. A bundle is a purchasable product, consisting of one or more products that you want to sell together. \n\nSee [**Bundles**](/docs/api/pxm/products/products#bundles).\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product\",\n \"attributes\": {\n \"external_ref\": \"d0ddf10c-402c-4e0f-b421-94e7f682c603\",\n \"name\": \"T-Shirt\",\n \"sku\": \"97805\",\n \"slug\": \"97805\",\n \"description\": \"T-shirt.\",\n \"status\": \"live\",\n \"commodity_type\": \"physical\",\n \"mpn\": \"1234-5678-TTTT\",\n \"upc_ean\": \"12345656\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"custom_inputs\": {\n \"front\": {\n \"name\": \"T-Shirt Front\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n },\n \"back\": {\n \"name\": \"T-Shirt Back\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n }\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"T_Shirt\",\n \"description\": \"T-Shirt.\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "060392c2-ba5e-42be-8585-3aeb71c705d9", "name": "Creates a product with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product\",\n \"attributes\": {\n \"external_ref\": \"d0ddf10c-402c-4e0f-b421-94e7f682c603\",\n \"name\": \"T-Shirt\",\n \"sku\": \"97805\",\n \"slug\": \"97805\",\n \"description\": \"T-shirt.\",\n \"status\": \"live\",\n \"commodity_type\": \"physical\",\n \"mpn\": \"1234-5678-TTTT\",\n \"upc_ean\": \"12345656\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"custom_inputs\": {\n \"front\": {\n \"name\": \"T-Shirt Front\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n },\n \"back\": {\n \"name\": \"T-Shirt Back\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n }\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"T_Shirt\",\n \"description\": \"T-Shirt.\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\",\n \"attributes\": {\n \"commodity_type\": \"physical\",\n \"custom_inputs\": {\n \"back\": {\n \"name\": \"T-Shirt Back\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n },\n \"front\": {\n \"name\": \"T-Shirt Front\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n }\n },\n \"description\": \"T-shirt.\",\n \"external_ref\": \"d0ddf10c-402c-4e0f-b421-94e7f682c603\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"T-Shirt\",\n \"description\": \"T-Shirt.\"\n }\n },\n \"mpn\": \"1234-5678-TTTT\",\n \"name\": \"T-Shirt\",\n \"sku\": \"97805\",\n \"slug\": \"97805\",\n \"status\": \"live\",\n \"upc_ean\": \"12345656\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/children\"\n }\n },\n \"component_products\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/component_products\"\n }\n },\n \"files\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/files\"\n }\n },\n \"main_image\": {\n \"data\": null\n },\n \"templates\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/templates\"\n }\n },\n \"variations\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/variations\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2022-08-18T14:25:57.391Z\",\n \"owner\": \"store\",\n \"product_types\": [\n \"standard\"\n ],\n \"updated_at\": \"2022-08-18T14:25:57.391Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50290262-de5b-4f5f-a27c-491e73e4fec2", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product\",\n \"attributes\": {\n \"external_ref\": \"d0ddf10c-402c-4e0f-b421-94e7f682c603\",\n \"name\": \"T-Shirt\",\n \"sku\": \"97805\",\n \"slug\": \"97805\",\n \"description\": \"T-shirt.\",\n \"status\": \"live\",\n \"commodity_type\": \"physical\",\n \"mpn\": \"1234-5678-TTTT\",\n \"upc_ean\": \"12345656\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"custom_inputs\": {\n \"front\": {\n \"name\": \"T-Shirt Front\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n },\n \"back\": {\n \"name\": \"T-Shirt Back\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n }\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"T_Shirt\",\n \"description\": \"T-Shirt.\"\n }\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d65e243c-098e-4dae-a889-67b4927f0b88", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product\",\n \"attributes\": {\n \"external_ref\": \"d0ddf10c-402c-4e0f-b421-94e7f682c603\",\n \"name\": \"T-Shirt\",\n \"sku\": \"97805\",\n \"slug\": \"97805\",\n \"description\": \"T-shirt.\",\n \"status\": \"live\",\n \"commodity_type\": \"physical\",\n \"mpn\": \"1234-5678-TTTT\",\n \"upc_ean\": \"12345656\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"custom_inputs\": {\n \"front\": {\n \"name\": \"T-Shirt Front\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n },\n \"back\": {\n \"name\": \"T-Shirt Back\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n }\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"T_Shirt\",\n \"description\": \"T-Shirt.\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d332f447-64fd-476f-9e86-8f4e9cb94c64", "name": "Get all products", "request": { "name": "Get all products", "description": { "content": "Retrieves a list of all your products in the Product Experience Manager system.\n\nYou can also use `include` to retrieve top-level resources, such as files or images, and key attribute data, such as SKU or slug for component products in a product bundle. With this option, you can get more information about the products in a product bundle in your store front, improving the buying experience for your shoppers.\n\n#### Pagination\n\nThis endpoint supports offset-based pagination using `page[offset]` and `page[limit]` query parameters.\n\n:::caution Planned pagination changes — on or after 1 September 2026\n\nThe pagination links returned by this endpoint currently differ from the Elastic Path Commerce Cloud platform standard. Specifically, the `current` link is not returned, `first`/`last` are not always present, `prev` is incorrectly omitted on the second page, and `next` is incorrectly omitted on the second-to-last page.\n\nOn or after **1 September 2026**, this endpoint will be updated so that `current` and `first` are always present, `last` is present on every page except the final page, `next` is present on every page except the last, and `prev` is present on every page except the first. See the [links](/docs/api/pxm/products/get-all-products#links) schema for full details.\n\nIf your integration iterates through pages using these links, please verify that it will handle the updated behaviour correctly before this date.\n\n:::\n\n#### Filtering\n\n Many Commerce API endpoints support filtering. The general syntax is described in [**Filtering**](/guides/Getting-Started/filtering).\n\n The following attributes and operators are supported.\n\n| Operator | Attribute | Description | Example |\n| :------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------------------------------------------- |\n| `eq` | `id`, `sku`, `slug`, `upc_ean`, `manufacturer_part_num`, `name`, `templates`, `commodity_type`, `owner`, `product_types`, `parent_id`, `component_option_id`, `tags`, `status`, `has_nodes (false only)`, `created_at`, `updated_at`, `external_ref`, `description` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. For `product_types`, you can only specify one product type. **Note:** `has_nodes` can only be filtered as `false`. **Note:** `component_option_id` matches when a bundle includes that product id as a component option. | `?filter=eq(name,some-name)` |\n| `like` | `sku`, `slug`, `upc_ean`, `manufacturer_part_num`, `name`, `tags`, `description`, `external_ref` | Like. Checks if the operand contains the specified string. Wildcards are supported. | `?filter=like(name,*some-name*)` |\n| `in` | `id`, `name`, `sku`, `slug`, `upc_ean`, `manufacturer_part_num`, `product_types`, `parent_id`, `component_option_id`, `tags`, `external_ref` | Checks if the values are included in the specified list. If they are, the condition is true. For `product_types`, you can specify more than one product type. | `?filter=in(id,some-id)` |\n| `gt` | `id`, `created_at`, `updated_at`, `external_ref` | Greater than. Checks if the value of the field is greater than the given value. | `?filter=gt(updated_at,2024-01-01T00:00:00Z)` |\n| `ge` | `id`, `created_at`, `updated_at`, `external_ref` | Greater than or equal to. Checks if the value of the field is greater than or equal to the given value. | `?filter=ge(created_at,2023-01-01T00:00:00Z)` |\n| `lt` | `id`, `created_at`, `updated_at`, `external_ref` | Less than. Checks if the value of the field is less than the given value. | `?filter=lt(updated_at,2025-01-01T00:00:00Z)` |\n| `le` | `id`, `created_at`, `updated_at`, `external_ref` | Less than or equal to. Checks if the value of the field is less than or equal to the given value. | `?filter=le(created_at,2022-01-01T00:00:00Z)` |\n| `eq` (extensions) | `extensions.book.isbn` | Filters using a nested extension field. | `?filter=eq(extensions.book.isbn,1765426)` |\n| `eq` (shopper_attributes) | `shopper_attributes.color` | Filters using a shopper custom attribute field. | `?filter=eq(shopper_attributes.color,red)` |\n| `eq` (admin_attributes) | `admin_attributes.warehouse` | Filters using an admin custom attribute field. | `?filter=eq(admin_attributes.warehouse,US-EAST)` |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n\nFor more information about the attributes and operators that are supported, see [Get all products](/docs/api/pxm/products/get-all-products).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,main_image" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "df1dac32-6f23-4747-8d17-dff131666dd7", "name": "Returns a list of all products.", "originalRequest": { "url": { "path": [ "pcm", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n\nFor more information about the attributes and operators that are supported, see [Get all products](/docs/api/pxm/products/get-all-products).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,main_image" } ], "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 \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\",\n \"attributes\": {\n \"commodity_type\": \"physical\",\n \"custom_inputs\": {\n \"back\": {\n \"name\": \"T-Shirt Back\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n },\n \"front\": {\n \"name\": \"T-Shirt Front\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n }\n },\n \"description\": \"T-shirt.\",\n \"mpn\": \"1234-5678-TTTT\",\n \"name\": \"T-Shirt\",\n \"sku\": \"97805\",\n \"slug\": \"97805\",\n \"status\": \"live\",\n \"upc_ean\": \"12345656\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"extensions\": {\n \"products(size)\": {\n \"widthMM\": 600,\n \"fuelType\": \"electric\",\n \"hasUKPlug\": true,\n \"online\": null\n }\n }\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/children\"\n }\n },\n \"component_products\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/component_products\"\n }\n },\n \"files\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/files\"\n }\n },\n \"main_image\": {\n \"data\": null\n },\n \"templates\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/templates\"\n }\n },\n \"variations\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/variations\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2022-08-18T14:25:57.391Z\",\n \"owner\": \"store\",\n \"product_types\": [\n \"standard\"\n ],\n \"updated_at\": \"2022-08-18T14:25:57.391Z\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 1\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81361528-5446-4774-aa1c-5b77042cb00b", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n\nFor more information about the attributes and operators that are supported, see [Get all products](/docs/api/pxm/products/get-all-products).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,main_image" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27dd215f-c33a-4ac5-a03f-80046f87b7ed", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n\nFor more information about the attributes and operators that are supported, see [Get all products](/docs/api/pxm/products/get-all-products).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,main_image" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7cf55164-42b3-4a86-a866-e179c64b256d", "name": "Get a product", "request": { "name": "Get a product", "description": { "content": "Returns a product by its identifier. \n\nYou can also use `include=component_products` to retrieve top-level resources, such as files or images, and key attribute data, such as SKU or slug for component products in a product bundle. With this option, you can get more information about the products in a product bundle in your store front, improving the buying experience for your shoppers.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,main_image" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dfc05e3c-d3b3-4ea8-a329-b5776f6b8ccc", "name": "Returns a product by its identifier.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,main_image" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"type\": \"product\",\n \"id\": \"f5bd4e59-a95f-4bda-bfe6-0f34f47ac94b\",\n \"attributes\": {\n \"commodity_type\": \"physical\",\n \"description\": \"This electric model offers an induction heating element and convection oven.\",\n \"mpn\": \"BE-R-1111-aaaa-1a1a\",\n \"name\": \"BestEver Range, Model 1a1a\",\n \"sku\": \"BE-Range-1a1a\",\n \"slug\": \"bestever-range-1a1a\",\n \"status\": \"draft\",\n \"upc_ean\": \"111122223333\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"extensions\": {\n \"products(size)\": {\n \"widthMM\": 600,\n \"fuelType\": \"electric\",\n \"hasUKPlug\": true,\n \"online\": null\n }\n }\n },\n \"relationships\": {\n \"custom_relationships\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/f5bd4e59-a95f-4bda-bfe6-0f34f47ac94b/custom-relationships\",\n \"CRP_summer_session\": \"/products/f5bd4e59-a95f-4bda-bfe6-0f34f47ac94b/custom-relationships/CRP_summer_session/products\",\n \"CRP_winter_session\": \"/products/f5bd4e59-a95f-4bda-bfe6-0f34f47ac94b/custom-relationships/CRP_winter_session/products\"\n }\n },\n \"files\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/f5bd4e59-a95f-4bda-bfe6-0f34f47ac94b/relationships/files\"\n }\n },\n \"templates\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/f5bd4e59-a95f-4bda-bfe6-0f34f47ac94b/relationships/templates\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2023-09-28T10:43:41.72Z\",\n \"owner\": \"organization\",\n \"product_types\": [\n \"standard\"\n ],\n \"updated_at\": \"2023-09-28T10:43:41.72Z\",\n \"variation_matrix\": {},\n \"custom_relationships\": [\n \"CRP_summer_session\",\n \"CRP_winter_session\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9a69e83-84ce-4412-bfaa-5d9d37c98afd", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,main_image" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d554be6-28e5-4d7e-914f-4fbc397a4922", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,main_image" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f41c1191-c703-417c-9ead-b245c0076e15", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n", "type": "text/plain" }, "key": "include", "value": "main_image,main_image" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d43f887-0160-46af-bdf1-57f981b7a2a7", "name": "Update a product or bundle", "request": { "name": "Update a product or bundle", "description": { "content": "Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the product or bundle is not updated.", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product\",\n \"id\": \"60afe403-a191-455e-b771-c510c928a308\",\n \"attributes\": {\n \"name\": \"UPDATED BestEver Range, Model 1a1a\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c8267284-6b47-416a-8719-fb2799c0f547", "name": "Updates a product with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": {\n \"type\": \"product\",\n \"id\": \"60afe403-a191-455e-b771-c510c928a308\",\n \"attributes\": {\n \"name\": \"UPDATED BestEver Range, Model 1a1a\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"product\",\n \"id\": \"60afe403-a191-455e-b771-c510c928a308\",\n \"attributes\": {\n \"commodity_type\": \"physical\",\n \"description\": \"The 30 inch version of this popular electric range.\",\n \"mpn\": \"BE-R-1111-aaaa-1a1a-30\",\n \"name\": \"UPDATED BestEver Range 30 inch, Model 1a1a-30\",\n \"sku\": \"BE-Range-1a1a-30\",\n \"slug\": \"bestever-range-1a1a-30\",\n \"status\": \"draft\",\n \"upc_ean\": \"111130303030\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"MISE À JOUR de la gamme BestEver 30 pouces, modèle 1a1a-30\",\n \"description\": \"La version 30 pouces de cette cuisinière électrique populaire\"\n }\n },\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n },\n \"relationships\": {\n \"files\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/60afe403-a191-455e-b771-c510c928a308/relationships/files\"\n }\n },\n \"templates\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/60afe403-a191-455e-b771-c510c928a308/relationships/templates\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2023-09-28T10:43:41.72Z\",\n \"owner\": \"organization\",\n \"product_types\": [\n \"standard\"\n ],\n \"updated_at\": \"2023-09-28T10:43:41.72Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9340fd4f-0d16-4e73-bdf5-61301ee20d96", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": {\n \"type\": \"product\",\n \"id\": \"60afe403-a191-455e-b771-c510c928a308\",\n \"attributes\": {\n \"name\": \"UPDATED BestEver Range, Model 1a1a\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7294646f-01d9-4a2e-9a4a-21c1cb6781e2", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": {\n \"type\": \"product\",\n \"id\": \"60afe403-a191-455e-b771-c510c928a308\",\n \"attributes\": {\n \"name\": \"UPDATED BestEver Range, Model 1a1a\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e80d51a0-1ef0-45af-94ea-714e69237116", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": {\n \"type\": \"product\",\n \"id\": \"60afe403-a191-455e-b771-c510c928a308\",\n \"attributes\": {\n \"name\": \"UPDATED BestEver Range, Model 1a1a\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9be47354-6171-4b02-8c8c-b52e6bb27402", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": {\n \"type\": \"product\",\n \"id\": \"60afe403-a191-455e-b771-c510c928a308\",\n \"attributes\": {\n \"name\": \"UPDATED BestEver Range, Model 1a1a\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1043b6f0-6f11-4f6b-b5ae-67680e0dc857", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": {\n \"type\": \"product\",\n \"id\": \"60afe403-a191-455e-b771-c510c928a308\",\n \"attributes\": {\n \"name\": \"UPDATED BestEver Range, Model 1a1a\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "72e67662-40ee-44cf-b5fd-8907831278fe", "name": "Delete a product", "request": { "name": "Delete a product", "description": { "content": "Deletes the specified product.\n\nYou cannot delete a product if it is part of a bundle. You must first delete the bundle before you delete the product.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "0e3a3cf0-77dd-4156-ac9f-52f3d662b29f", "name": "Deletes the specified product.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "235a4637-8fb6-47d2-97ca-20f7a2676b39", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0514e9e-f924-4537-bda4-cc101e67acca", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3e2a3a9-857c-4f3d-b25d-5bd382e3752b", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90c4b333-11c1-4889-98b9-e216ecb4c930", "name": "Attach multiple nodes", "request": { "name": "Attach multiple nodes", "description": { "content": "Assigns products to multiple hierarchies and their children nodes. You can apply a filter to search for the appropriate products to attach to a node. For general filtering syntax, see [**Filtering**](/guides/Getting-Started/filtering).\n \n The following attributes and operators are supported.\n \n | Operator | Attribute | Description | Example |\n | :------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------------------------------------------- |\n | `eq` | `id`, `sku`, `slug`, `upc_ean`, `manufacturer_part_num`, `name`, `templates`, `commodity_type`, `owner`, `product_types`, `parent_id`, `component_option_id`, `tags`, `status`, `has_nodes (false only)`, `created_at`, `updated_at`, `external_ref`, `description` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. For `product_types`, you can only specify one product type. **Note:** `has_nodes` can only be filtered as `false`. **Note:** `component_option_id` matches when a bundle includes that product id as a component option. | `?filter=eq(name,some-name)` |\n | `like` | `sku`, `slug`, `upc_ean`, `manufacturer_part_num`, `name`, `tags`, `description`, `external_ref` | Like. Checks if the operand contains the specified string. Wildcards are supported. | `?filter=like(name,*some-name*)` |\n | `in` | `id`, `name`, `sku`, `slug`, `upc_ean`, `manufacturer_part_num`, `product_types`, `parent_id`, `component_option_id`, `tags`, `external_ref` | Checks if the values are included in the specified list. If they are, the condition is true. For `product_types`, you can specify more than one product type. | `?filter=in(id,some-id)` |\n | `gt` | `id`, `created_at`, `updated_at`, `external_ref` | Greater than. Checks if the value of the field is greater than the given value. | `?filter=gt(updated_at,2024-01-01T00:00:00Z)` |\n | `ge` | `id`, `created_at`, `updated_at`, `external_ref` | Greater than or equal to. Checks if the value of the field is greater than or equal to the given value. | `?filter=ge(created_at,2023-01-01T00:00:00Z)` |\n | `lt` | `id`, `created_at`, `updated_at`, `external_ref` | Less than. Checks if the value of the field is less than the given value. | `?filter=lt(updated_at,2025-01-01T00:00:00Z)` |\n | `le` | `id`, `created_at`, `updated_at`, `external_ref` | Less than or equal to. Checks if the value of the field is less than or equal to the given value. | `?filter=le(created_at,2022-01-01T00:00:00Z)` |\n | `eq` (extensions) | `extensions.book.isbn` | Filters using a nested extension field. | `?filter=eq(extensions.book.isbn,1765426)` |\n | `eq` (shopper_attributes) | `shopper_attributes.color` | Filters using a shopper custom attribute field. | `?filter=eq(shopper_attributes.color,red)` |\n | `eq` (admin_attributes) | `admin_attributes.warehouse` | Filters using an admin custom attribute field. | `?filter=eq(admin_attributes.warehouse,US-EAST)` |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products", "attach_nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"filter\": \"eq(sku,book)\",\n \"node_ids\": [\n \"123\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "41e35e6e-24bf-49d2-a38a-77f2e8a6b3f2", "name": "This request assigns the products that you have selected to multiple hierarchies and their children nodes and returns the following.", "originalRequest": { "url": { "path": [ "pcm", "products", "attach_nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"filter\": \"eq(sku,book)\",\n \"node_ids\": [\n \"123\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"nodes_attached\": 3,\n \"nodes_not_found\": []\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "548db6d7-ed22-44f6-8b4a-f2a1c0448308", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", "attach_nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"filter\": \"eq(sku,book)\",\n \"node_ids\": [\n \"123\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "614ac526-4368-4e03-9869-69d743230ddc", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", "attach_nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"filter\": \"eq(sku,book)\",\n \"node_ids\": [\n \"123\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d59f367-b420-4a2f-90bf-6d39c2550806", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", "attach_nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"filter\": \"eq(sku,book)\",\n \"node_ids\": [\n \"123\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94a7b228-f9a1-4e00-a6f8-c55bacf9e31d", "name": "Detach multiple nodes", "request": { "name": "Detach multiple nodes", "description": { "content": "Dissociates products from multiple hierarchies and their children nodes. You can apply filters to search for the appropriate products to detach. For general filtering syntax, see [**Filtering**](/guides/Getting-Started/filtering).\n \nThe following attributes and operators are supported.\n \n | Operator | Attribute | Description | Example |\n | :------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------------------------------------------- |\n | `eq` | `id`, `sku`, `slug`, `upc_ean`, `manufacturer_part_num`, `name`, `templates`, `commodity_type`, `owner`, `product_types`, `parent_id`, `component_option_id`, `tags`, `status`, `has_nodes (false only)`, `created_at`, `updated_at`, `external_ref`, `description` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. For `product_types`, you can only specify one product type. **Note:** `has_nodes` can only be filtered as `false`. **Note:** `component_option_id` matches when a bundle includes that product id as a component option. | `?filter=eq(name,some-name)` |\n | `like` | `sku`, `slug`, `upc_ean`, `manufacturer_part_num`, `name`, `tags`, `description`, `external_ref` | Like. Checks if the operand contains the specified string. Wildcards are supported. | `?filter=like(name,*some-name*)` |\n | `in` | `id`, `name`, `sku`, `slug`, `upc_ean`, `manufacturer_part_num`, `product_types`, `parent_id`, `component_option_id`, `tags`, `external_ref` | Checks if the values are included in the specified list. If they are, the condition is true. For `product_types`, you can specify more than one product type. | `?filter=in(id,some-id)` |\n | `gt` | `id`, `created_at`, `updated_at`, `external_ref` | Greater than. Checks if the value of the field is greater than the given value. | `?filter=gt(updated_at,2024-01-01T00:00:00Z)` |\n | `ge` | `id`, `created_at`, `updated_at`, `external_ref` | Greater than or equal to. Checks if the value of the field is greater than or equal to the given value. | `?filter=ge(created_at,2023-01-01T00:00:00Z)` |\n | `lt` | `id`, `created_at`, `updated_at`, `external_ref` | Less than. Checks if the value of the field is less than the given value. | `?filter=lt(updated_at,2025-01-01T00:00:00Z)` |\n | `le` | `id`, `created_at`, `updated_at`, `external_ref` | Less than or equal to. Checks if the value of the field is less than or equal to the given value. | `?filter=le(created_at,2022-01-01T00:00:00Z)` |\n | `eq` (extensions) | `extensions.book.isbn` | Filters using a nested extension field. | `?filter=eq(extensions.book.isbn,1765426)` |\n | `eq` (shopper_attributes) | `shopper_attributes.color` | Filters using a shopper custom attribute field. | `?filter=eq(shopper_attributes.color,red)` |\n | `eq` (admin_attributes) | `admin_attributes.warehouse` | Filters using an admin custom attribute field. | `?filter=eq(admin_attributes.warehouse,US-EAST)` |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products", "detach_nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"filter\": \"eq(sku,book)\",\n \"node_ids\": [\n \"123\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c2a48acc-4913-45f1-8446-22f88402af5d", "name": "The request dissociates the products that you have selected from multiple hierarchies and their children and returns the following.", "originalRequest": { "url": { "path": [ "pcm", "products", "detach_nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"filter\": \"eq(sku,book)\",\n \"node_ids\": [\n \"123\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"nodes_detached\": 1,\n \"nodes_not_found\": []\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d25cd57e-3c0c-43d2-85ed-6669dab92c87", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", "detach_nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"filter\": \"eq(sku,book)\",\n \"node_ids\": [\n \"123\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7563682f-e127-4f78-b951-64cf5e0aa9c5", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", "detach_nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"filter\": \"eq(sku,book)\",\n \"node_ids\": [\n \"123\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "520d0d65-1cfc-4d40-98f4-233359063aa3", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", "detach_nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"filter\": \"eq(sku,book)\",\n \"node_ids\": [\n \"123\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee9c8e05-d5ff-4f78-851a-418c8868ee3d", "name": "Get a product's nodes", "request": { "name": "Get a product's nodes", "description": { "content": "Returns the nodes associated with the product. Products must be in a `live` status.", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "99afc6e2-09a1-433f-815e-4640679c4a2f", "name": "Successfully returns the product's nodes.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"type\": \"node\",\n \"attributes\": {\n \"description\": \"Latest Ballet Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n },\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:19:50.087Z\",\n \"owner\": \"store\",\n \"sort_order\": 5,\n \"updated_at\": \"2024-01-11T19:56:53.695Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 1 in French\"\n }\n }\n }\n ]\n }\n },\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\",\n \"attributes\": {\n \"description\": \"All Dress Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures habillées\",\n \"description\": \"Toutes les chaussures habillées\"\n }\n },\n \"name\": \"Dress Shoes\",\n \"slug\": \"dress-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/b2f5e53e-de3c-4548-98da-120f8b185d34/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/b2f5e53e-de3c-4548-98da-120f8b185d34/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:50:21.729Z\",\n \"owner\": \"store\",\n \"sort_order\": 3,\n \"updated_at\": \"2024-01-11T19:50:21.729Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\",\n \"name\": \"Dress Shoes\",\n \"slug\": \"dress-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 2 in French\"\n }\n }\n }\n ]\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7511c320-84f2-479b-b263-6b9a79d65871", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e834af5a-9e55-4e49-9b42-72c7bb5b9618", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9769173c-3c82-40a6-910e-8ab6dfdf4832", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Product Tags", "description": "```mdx-code-block\nimport ProductTags from '/docs/partials/pxm/products/tags.mdx';\n\n\n```\n", "item": [ { "id": "d7fd5a87-0e56-4de9-bb5c-0e936e440c8f", "name": "Get All Product Tags", "request": { "name": "Get All Product Tags", "description": { "content": "Retrieves all product tags for a store. A store can view the tags associated with the organization to which the store belongs. However, an organization can only view the tags associated with the organization.\n \n", "type": "text/plain" }, "url": { "path": [ "pcm", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e9e5c6d5-65b4-4c64-a38d-3168d1a1dc1a", "name": "Returns all the product tags.", "originalRequest": { "url": { "path": [ "pcm", "tags" ], "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" } ], "body": "{\n \"data\": [\n {\n \"type\": \"tag\",\n \"id\": \"a88aac35-54de-40c2-bb4b-f1c57624db27\",\n \"attributes\": {\n \"value\": \"shirts\"\n },\n \"meta\": {\n \"created_at\": \"2024-03-20T15:56:40.014Z\",\n \"owner\": \"store\",\n \"updated_at\": \"2024-03-20T15:56:40.014Z\"\n }\n },\n {\n \"type\": \"tag\",\n \"id\": \"6782e020-fefd-431e-9dea-b59d249c2c5e\",\n \"attributes\": {\n \"value\": \"shoes\"\n },\n \"meta\": {\n \"created_at\": \"2024-03-20T15:56:40.014Z\",\n \"owner\": \"store\",\n \"updated_at\": \"2024-03-20T15:56:40.014Z\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e3f8f0e-2fc3-4110-a744-1caae1ddfaba", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "tags" ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83a91fc4-5b42-40a0-987f-b5ed38a899d3", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "tags" ], "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": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aa78e67-e60d-4565-89a4-02dc44dda494", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "tags" ], "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d89fcae-9e30-4a4f-ab11-b43c7bd135a4", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "tags" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "615d188b-5418-4e78-938a-409b6b400501", "name": "Get a Product Tag", "request": { "name": "Get a Product Tag", "description": { "content": "Retrieves a product tag for a store. A store can view the tags associated with the organization to which the store belongs. However, an organization can only view the tags associated with the organization.", "type": "text/plain" }, "url": { "path": [ "pcm", "tags", ":tagID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "tagID", "disabled": false, "description": { "content": "(Required) A unique identifier for the tag.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "67112e43-daf9-4dba-a60d-c06d412a528e", "name": "Returns a product tag with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "tags", ":tagID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the tag.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "tagID" } ] }, "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 \"type\": \"tag\",\n \"id\": \"9879a8f5-0da2-4be6-91f6-a0f09d1c77a9\",\n \"attributes\": {\n \"value\": \"tables\"\n },\n \"meta\": {\n \"created_at\": \"2024-03-20T18:37:43.398Z\",\n \"owner\": \"organization\",\n \"updated_at\": \"2024-03-20T18:37:43.398Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fffc970-bbea-4b0c-a79c-e50b1d89d282", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "tags", ":tagID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the tag.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "tagID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f2fcfa5-58e9-4f76-a663-1b45191f4f4f", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "tags", ":tagID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the tag.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "tagID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91b88359-792e-4b45-8344-d6e5f9eb08f5", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "tags", ":tagID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the tag.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "tagID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b49cd50f-7072-4328-a1d4-f9c6e96a2ff2", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "tags", ":tagID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the tag.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "tagID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Extending Products with Templates", "description": "```mdx-code-block\nimport TemplatesOverview from '/docs/partials/pxm/templates/extendingproducts.mdx';\n\n\n```\n", "item": [ { "id": "0ed98215-08fb-4745-8780-86afa2425539", "name": "Create a product template relationship", "request": { "name": "Create a product template relationship", "description": { "content": "Retrieves all the templates that are associated with the specified product.", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a3b00fe2-6772-4317-bebc-9085eacf63c8", "name": "Returns a created product template relationship.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15f1b184-21de-4b4d-aed7-638290b88cb1", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "465a5971-ae7c-4801-98db-34b96e49d13e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4738800-e4c5-4adf-bc80-021aa69ef0e7", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98ebf436-b820-43d8-9076-bb6c2e8edec3", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21788059-a234-46f8-b4c5-7c1b81720eee", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5af19a16-ad94-4a3b-bd9b-7f04920af083", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4480de61-6797-4ce3-9e41-aea423ac65f6", "name": "Get all product template relationships", "request": { "name": "Get all product template relationships", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "acf12b33-db65-4d40-89d7-f83f971f6aaa", "name": "Returns all product template relationships.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d36faaf9-d5f3-424b-a7d6-eafa2bf6a7ef", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b62c3fa5-c2e0-469a-b9a2-e5a60094a9c2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5be57b3e-7065-43d3-b12f-cdf4b6f7c0ff", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a71612fa-68da-4357-9bc1-3f5b4e937a37", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2533a82-8080-4580-8cfd-ad59883732be", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2fc374c-7b3f-4c92-b197-b66677b13cad", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e556988-c98e-4059-b744-d68eb79d9fb4", "name": "Delete a product template relationship", "request": { "name": "Delete a product template relationship", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "477a0798-9571-4a43-9e01-29c57512cb0a", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c3559f87-74af-435a-9d6c-a6dd93180c21", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a47fe892-f3de-439f-b288-702f38db5942", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "700a990d-1132-47be-9172-8c1896e5d977", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20a77da2-ffb3-4c91-bd25-b799ac50be1f", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "107c01c1-25f8-4600-ab82-14f4c5a27a95", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62975002-5bbe-4889-b69a-c9705136d92a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"template\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"template\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Bundle Component Products Relationships", "description": "With Product Experience Manager, you can create and manage bundles. A bundle is a purchasable product, consisting of one or more products that you want to sell together.\n\nYou can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity.\n", "item": [ { "id": "0e6cb705-e5b7-4354-a52b-7df3d2690bb9", "name": "Get Bundle Component Product Relationships", "request": { "name": "Get Bundle Component Product Relationships", "description": { "content": "Retrieves all the products included in the specified bundle product.", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "25a9a0fe-1f13-4e87-81da-9f4df88b150e", "name": "Returns all Component Products relationships.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"product\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e575bbc4-6abc-4f34-ae7e-36134e4c27da", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7cc46be-9b78-4b30-a379-4c1b1f5d18bd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77c00494-c1e1-4aea-9021-32141c9ccafe", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "735af85c-705f-49ef-bf60-725b8ef40bf4", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1082cc96-2982-4361-a253-ae9ec3544771", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3088c96-d85f-4166-b84f-0a3c9ff63fef", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "component_products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Variations", "description": "```mdx-code-block\nimport VariationsOverview from '/docs/partials/pxm/variations/variationsoverview.mdx';\nimport VariationsReusability from '/docs/partials/pxm/variations/variationsreusability.mdx';\nimport ChildProducts from '/docs/partials/pxm/variations/childproducts.mdx';\nimport BuildChildren from '/docs/partials/pxm/variations/buildchildproducts.mdx';\nimport ProductModifiers from '/docs/partials/pxm/variations/productmodifiers.mdx';\nimport PriceModifiers from \"/docs/partials/pxm/variations/pricemodifiers.mdx\";\n\n\n\n### Reusability\n\n\n\n### Child Products\n\n\n\n### Building Child Products\n\n\n\n### Sorting the Order of Variations and Options\n\nThe `variation_matrix` object lists the variation IDs and variation option IDs and their corresponding product IDs that are generated when the variation and variation options are built with a product. The `variation_matrix` can then be added to your catalogs.\n\nThe order of the variations in the `variation_matrix` is the order of the variations in the array when the variations were linked to the product. For example, the first variation in the `variation_matrix` corresponds to the first variation in the array, and so on. You can use the `sort_order`attribute to sort the order of your variation and variation options in the `variation_matrix` object. The sort order value is visible when you add the variations and variation options to your catalogs. You can then use the `sort_order` value to program your storefront to display the variations and variation options in the order that you want.\n\nAdd the `sort_order` attribute to the body of your request and specify a `sort_order` value. A `sort_order` value must be a number. You can specify any numbers that you want.\n\n- 1, 2, 3, or 100, 90, 80, and so on.\n- Zero or negative numbers.\n\nYou can set `sort_order` to either `null` or omit it entirely from the request if you wish to remove an existing `sort_order` attribute.\n\n:::caution\n\n- Commerce does not sort variations and variation options. You must program your storefront to sort the variations and variation options in the order that you want.\n- You must rebuild your products for the sort order changes to take effect. See [**Build Child Products**](#build-child-products).\n\n:::\n\n### Product Modifiers\n\n\n\n### Price Modifiers\n\n\n```\n", "item": [ { "id": "3747ff3a-9920-489b-92ed-9e9f51c4eadf", "name": "Build child products", "request": { "name": "Build child products", "description": { "content": "With product variations in Product Experience Manager, you can create product variations and different options for each variation and use both to create child products for a product. Each child product is a unique combination of options associated with the product. \n\nChild products inherit attributes from their parent products. When you make changes to the attributes of the parent products, you can rebuild your child products, ensuring that changes to the parent products are propagated to the child products.\n\nAlternatively, you can modify a child product independently, without impacting its parent product. For example, you may prefer the status of your child product to be `live`, while keeping the parent product's status as `draft`. When you directly update a child product, it becomes independent of its parent product. In other words, any subsequent changes made to the parent product are not automatically reflected in the child product when you rebuild the parent product and its child products. Once a child product is independent of its parent, you cannot recreate the association between the child product and its parent. You must delete the child product and rebuild the parent to recreate the child product.\n\nFollowing on from that, if you add the same flow to both a parent and child product, the child flow values are not affected by changes to the parent flow values in a rebuild.\n\n### Using Build Rules\n\nWhen building your child products, you can build all products related to a product. \n\nAlternatively, you can build a combination of child products associated with a product, based on build rules that you specify. This is useful, for example, if you have a variation option that you do not sell. This makes managing and building your child products quick and easy. You can do this using `build_rules`. `build_rules` are combinations of variation option IDs that you wish to include or exclude when building your child products.\n\n:::note\n\nYou do not need to configure any `build_rules` in the following scenarios:\n\n- Child products must be built with all variation options. Simply, use the `Create a product` or `Update a product` endpoints with no `build_rules` specified.\n- Child products must be built apart from all options for a specific variation. In this case, you must remove the variation and use the `Create a product` or `Update a product` endpoints with no `build_rules` specified. In other words, using our example, if none of the `size` options should be included, then remove the `size` variation.\n\n:::\n\nThe `build_rules` contain:\n\n- (Required) `default`: specifies the default behavior.\n- (Optional) `include`: specifies the option IDs to include when the child products are built. Each combination consists of a nested array of option IDs from one or more variations. Combinations of option IDs in the nested arrays must come from different variations. See [**Invalid Build Rules**](#invalid-build-rules).\n- (Optional) `exclude`: specifies the option IDs to exclude when the child products are built. Each combination consists of a nested array of option IDs from one or more variations. Combinations of option IDs in the nested arrays must come from different variations. See [**Invalid build rules**](#invalid-build-rules).\n\nWhen building child products, Commerce compares each combination of option IDs to these rules to determine how your child products should be built, depending on how you have configured the `build_rules`. It depends on your requirements how you configure your `build_rules`.\n\n#### Invalid Build Rules\n\nThe `build_rules` are invalid if both the option IDs come from the same variation. Combinations of option IDs in the nested arrays must come from different variations.\n\nIf Commerce cannot resolve the `build_rules` a `could not determine whether to include or exclude a child product due to ambiguous rules` error is returned. This error can occur, for example, if you have the same number of variation option IDs in both the `include` and `exclude` arrays and the variation option IDs match.\n\n### Building Child Products\n\nBuilding child products is an asynchronous operation. When you build child products, a job is created. The jobId of the job is displayed in the response. When the job is complete, the build child products operation is also complete. You can use the jobId to see the status of your job using the `Get a Job` endpoint.\n\nJobs are processed one at a time. You can continue to send build child product requests, but those jobs are queued. In other words, Commerce looks for any jobs that have a status of PENDING and starts the job with the earliest created date. This process is repeated until all jobs are processed. See Jobs.\n\nRe-building child products after adding or removing a new variation changes the total number of child products that you can generate from a parent product. When you rebuild the child products after updating variations associated with the parent product, all existing child products that belong to a parent product are deleted. New child products are created with new product IDs.\n\nIf you have any bundles that reference child products directly, then you must update the bundles with the new child product IDs.\n\nHowever, re-building child products after adding or removing an option does not change the existing product IDs.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID", "build" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e9355425-32b1-45d5-9052-73d25c90d802", "name": "Successfully started building child products", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "build" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"pim-job\",\n \"id\": \"dcc9e0bb-526b-4207-9e52-081589cdb50e\",\n \"attributes\": {\n \"completed_at\": null,\n \"created_at\": \"2024-11-01T14:11:00.917Z\",\n \"started_at\": null,\n \"status\": \"pending\",\n \"type\": \"child-products\",\n \"updated_at\": \"2024-11-01T14:11:00.917Z\"\n },\n \"meta\": {\n \"x_request_id\": \"85609bc9-6f19-4831-919a-a5b43e662061\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edce139f-2dd0-4b1d-8dd7-ea5fceedf485", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "build" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d14f1a1-eef8-4678-9b80-b6ffd49bcdf5", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "build" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0e1165a-60db-47e1-93ef-da56cb565472", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "build" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3348b9f6-8b09-4233-9c02-f9a95e62ebfa", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "build" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dcc86c13-bb98-4afd-9ba0-0e7bf6f1de19", "name": "Get child products", "request": { "name": "Get child products", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "104a24a1-9c51-43a6-a6c3-d806d618c4fe", "name": "Returns a list of child products for the specified parent product ID.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"type\": \"product\",\n \"id\": \"4d32b816-4397-4a71-b875-4e4ea3ce6745\",\n \"attributes\": {\n \"commodity_type\": \"physical\",\n \"name\": \"Jeans\",\n \"sku\": \"jeansRed\",\n \"slug\": \"jeansRed\",\n \"status\": \"live\"\n },\n \"relationships\": {\n \"base_product\": {\n \"data\": {\n \"type\": \"product\",\n \"id\": \"571e366f-17e6-4e51-8239-b3cc8ee1144d\"\n }\n },\n \"children\": {\n \"data\": []\n },\n \"component_products\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/4d32b816-4397-4a71-b875-4e4ea3ce6745/relationships/component_products\"\n }\n },\n \"files\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/4d32b816-4397-4a71-b875-4e4ea3ce6745/relationships/files\"\n }\n },\n \"main_image\": {\n \"data\": null\n },\n \"templates\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/4d32b816-4397-4a71-b875-4e4ea3ce6745/relationships/templates\"\n }\n },\n \"variations\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/4d32b816-4397-4a71-b875-4e4ea3ce6745/relationships/variations\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-05T10:29:44.603Z\",\n \"owner\": \"store\",\n \"product_types\": [\n \"child\"\n ],\n \"updated_at\": \"2024-01-05T10:29:45.155Z\",\n \"variation_matrix\": {},\n \"child_variations\": [\n {\n \"id\": \"119b2b76-0014-4077-826e-ae80ff207393\",\n \"name\": \"Size\",\n \"options\": null,\n \"option\": {\n \"id\": \"fad253ad-4485-4b35-8e3b-b475ad28e78d\",\n \"name\": \"Medium\",\n \"description\": \"Medium\"\n }\n },\n {\n \"id\": \"10ceafef-7ac9-4352-9797-4825a1671482\",\n \"name\": \"Colour\",\n \"options\": null,\n \"option\": {\n \"id\": \"b8128e51-1b0a-4b16-9eda-bb783b17026b\",\n \"name\": \"Red\",\n \"description\": \"#EE2238\"\n }\n }\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb97e715-7d29-444d-8cbd-4ae6b4e54fe0", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0efff390-cbe3-4649-a809-135dbd526f4f", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c5ca7af-8ea0-4aef-a9f7-4c97549457ee", "name": "Create a product variation relationship", "request": { "name": "Create a product variation relationship", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "49b8fca3-75b9-4cb3-95d3-e4e841521f32", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "header": [ { "key": "Content-Type", "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0522d4c-94a6-4a71-8cff-2c972a69215d", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "558ed0e9-db91-43f4-a0da-cd8aea0ca115", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7058e418-d2b0-4ed2-b5d9-f065fcf265c0", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a195359e-23f5-4a83-ae9c-150398835c65", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "146ccc81-c272-4a4f-9de3-a8a9ed59c62c", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03a55f86-4b6b-4215-a930-47ddbc5b9b3c", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac5c010b-bdc2-4f12-ac7a-38bc97bf7d6a", "name": "Get all product variation relationships", "request": { "name": "Get all product variation relationships", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2a27413c-56cf-4778-9e29-62eee6b85bc8", "name": "Returns all product variation relationships.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"product-variation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0f4fec9-13d4-4a38-a9c8-aa58ab9021da", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b81a4e5-c4d5-4a16-82f6-7f43c24ef31e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a394d3ad-9a0c-4517-ba67-ab0545a9a750", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d37ac3e-5212-4eed-ac66-fd17cd8c932e", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4969470-2671-4502-bc03-9b9ec6074dcb", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd75d57f-da5a-458c-8e9b-cca12516e423", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a7e29ad-656e-4100-b6a3-8528f4316ece", "name": "Replace a product variation relationship", "request": { "name": "Replace a product variation relationship", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ff5f427e-a3db-46db-a9e8-5dd64b3f82e9", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "header": [ { "key": "Content-Type", "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "43a636a5-675e-40d5-abdf-62b4f7c29a3b", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b6c7d41-6b86-4323-8f51-08b2f723191b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29fe8666-a2b2-4c26-9c40-d271ff726b91", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b26532cd-f088-45ae-bff0-be757b1812ff", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a40dee1-64bb-4112-867d-d0cdfc4172bd", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b5f3d69-4d11-410d-b3a0-1ec9e26e6023", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8a7bcf7-c143-481a-85bf-e55aa3243aa0", "name": "Delete a product variation relationships", "request": { "name": "Delete a product variation relationships", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e456888d-eb68-4b18-9ebd-633078e9cf08", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b08d0944-6ea7-4d5d-ab8f-90cbc8343af8", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d873e911-6e70-4b73-87b8-3fe459249021", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f0a490f-3dee-4c70-914a-c9d6c69f012e", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "499b6d57-58f8-41c5-8863-0a2270fb5adb", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "133c2e5b-d012-4078-96ec-4375b4db60b5", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb224b0f-24cc-4eae-96de-ffcd921515f1", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"product-variation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b057331-d944-4d05-aad6-0c5661cf943a", "name": "Create a variation", "request": { "name": "Create a variation", "description": {}, "url": { "path": [ "pcm", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 10\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7a16e67f-02f2-48ee-862c-201afb863a44", "name": "Returns a created variation with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 10\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 10\n },\n \"meta\": {\n \"owner\": \"store\",\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7253c65d-e5b6-4d39-ade2-0ae2c3857b86", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 10\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c3dc67d-9b9e-4f41-bc7e-a6ba606d51cc", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 10\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "843f6988-3e51-4074-b286-64cfcfa6c3c2", "name": "Get all variations", "request": { "name": "Get all variations", "description": {}, "url": { "path": [ "pcm", "variations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f8247e63-61c7-4045-9a82-6996c44a5554", "name": "Returns all variations.", "originalRequest": { "url": { "path": [ "pcm", "variations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "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 \"type\": \"product-variation\",\n \"id\": \"c1ccccba-53e4-46b5-aed8-94f32823148a\",\n \"attributes\": {\n \"name\": \"Size\",\n \"sort_order\": 1\n },\n \"meta\": {\n \"options\": [\n {\n \"id\": \"057a50ba-1afb-4944-9637-bd9b568a9f39\",\n \"name\": \"Large\",\n \"description\": \"Large size\",\n \"sort_order\": 3,\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n },\n {\n \"id\": \"fa191e68-9bba-49f9-8e12-056c4e8f50e2\",\n \"name\": \"Medium\",\n \"description\": \"Medium size\",\n \"sort_order\": 2,\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n },\n {\n \"id\": \"112d1c5c-d149-453e-b208-89470968bacf\",\n \"name\": \"Small\",\n \"description\": \"Small size\",\n \"sort_order\": 1,\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n }\n ],\n \"owner\": \"store\",\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n }\n },\n {\n \"type\": \"product-variation\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {\n \"name\": \"Paint Color\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e121e284-4a33-4cfb-9017-2e75699d4ce3", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00546bb8-9a63-49fe-8e81-2f1cfff5048e", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94ca2ac1-e509-4063-8089-92ff09a62ff1", "name": "Get a variation", "request": { "name": "Get a variation", "description": {}, "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID", "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bdaae8a9-36f5-47b1-92b1-67d3e4b1b566", "name": "Returns the specified variation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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 \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 1\n },\n \"meta\": {\n \"options\": [\n {\n \"id\": \"3de2c96c-2a99-4ded-bcf8-eeba32c0c5be\",\n \"name\": \"Red\",\n \"description\": \"Red color\",\n \"sort_order\": 2,\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n },\n {\n \"id\": \"31f2d09b-8a10-447a-b3ad-3358d07f818a\",\n \"name\": \"Blue\",\n \"description\": \"Blue color\",\n \"sort_order\": 1,\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n }\n ],\n \"owner\": \"store\",\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ef3dde6-43c7-479e-a07f-c56e59d7fdd1", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "375f86a8-d3ba-46fa-856d-5a11adad4b4f", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a178ee0-e460-4e57-97ba-36e7345cba85", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9197eead-c017-4fc3-9277-03ade9c13aa4", "name": "Update a variation", "request": { "name": "Update a variation", "description": { "content": "Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the variation is not updated.", "type": "text/plain" }, "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID", "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 0\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1b9a0fa0-56d9-4bef-854d-292a171d509d", "name": "Returns an updated variation with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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 \"data\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 0\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 1\n },\n \"meta\": {\n \"options\": [\n {\n \"id\": \"3de2c96c-2a99-4ded-bcf8-eeba32c0c5be\",\n \"name\": \"Red\",\n \"description\": \"Red color\",\n \"sort_order\": 2,\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n },\n {\n \"id\": \"31f2d09b-8a10-447a-b3ad-3358d07f818a\",\n \"name\": \"Blue\",\n \"description\": \"Blue color\",\n \"sort_order\": 1,\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n }\n ],\n \"owner\": \"store\",\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82c05d16-8445-48d6-8323-786384363ab3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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 \"data\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 0\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05a8ae40-3a17-474e-b1b2-a472b5c8e5a7", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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 \"data\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 0\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71b0cead-99ea-44d5-b160-c71acd245bae", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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 \"data\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 0\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c292ee47-e903-4ad0-907e-07edb3996cb1", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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 \"data\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 0\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da5e2bc0-2909-463d-abdd-d300608afe3c", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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 \"data\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"type\": \"product-variation\",\n \"attributes\": {\n \"name\": \"Paint Color\",\n \"sort_order\": 0\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cdd21461-e6ca-40d5-b73a-d473a75a94f2", "name": "Delete a variation and all it's associated options.", "request": { "name": "Delete a variation and all it's associated options.", "description": {}, "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID", "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "37b7272c-bc96-4e33-88a2-4a97e046b3b7", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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": "985d3114-e3f9-481e-b1ff-a79ebff18e15", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2ab5819-c2f9-4d61-8d85-292dd3bbd876", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f6cefda-2008-44a8-ae9e-1b3a9ddf3a0b", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3dfe4a20-11d5-4636-b540-ba450bd3d915", "name": "Create a variation option", "request": { "name": "Create a variation option", "description": {}, "url": { "path": [ "pcm", "variations", ":variationID", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID", "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation-option\",\n \"attributes\": {\n \"name\": \"Blue\",\n \"sort_order\": 0,\n \"description\": \"Our most popular color\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9f529438-db48-4970-9a62-a3370e8214f2", "name": "Successfully returns the created variation option.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation-option\",\n \"attributes\": {\n \"name\": \"Blue\",\n \"sort_order\": 0,\n \"description\": \"Our most popular color\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"product-variation-option\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {\n \"description\": \"Our most popular color\",\n \"name\": \"Blue\",\n \"sort_order\": 0\n },\n \"meta\": {\n \"owner\": \"store\",\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5abfbf52-162e-4f79-9995-d89a7dc889d3", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation-option\",\n \"attributes\": {\n \"name\": \"Blue\",\n \"sort_order\": 0,\n \"description\": \"Our most popular color\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "068a01ea-97ce-4817-ba9e-562b1a149912", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation-option\",\n \"attributes\": {\n \"name\": \"Blue\",\n \"sort_order\": 0,\n \"description\": \"Our most popular color\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86f1ab7f-d476-4de8-9c85-89188b14a20d", "name": "Get all variation options", "request": { "name": "Get all variation options", "description": {}, "url": { "path": [ "pcm", "variations", ":variationID", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID", "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "236c1340-48f3-48fd-8efb-a34f27b5c628", "name": "Successfully returns all variation options.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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 \"type\": \"product-variation-option\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {\n \"description\": \"Our most popular color\",\n \"name\": \"Blue\",\n \"sort_order\": 0\n },\n \"meta\": {\n \"owner\": \"store\",\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n }\n },\n {\n \"type\": \"product-variation-option\",\n \"id\": \"fbe73839-58a2-41b4-aca6-cb0724668c97\",\n \"attributes\": {\n \"description\": \"Our second most popular color\",\n \"name\": \"Red\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd5b2435-7517-4099-b028-986412181d5f", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d18e376-c4d2-438d-a4ee-55eda5ec8642", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f4f807d-e372-440e-b280-5101c2c67e0e", "name": "Get a variation option", "request": { "name": "Get a variation option", "description": {}, "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID", "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID", "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5e07bc1b-c8e5-4111-a77b-cf3a6e9c928d", "name": "Successfully returns the variation option.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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 \"type\": \"product-variation-option\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {\n \"description\": \"Our most popular color\",\n \"name\": \"Blue\",\n \"sort_order\": 0\n },\n \"meta\": {\n \"owner\": \"store\",\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7b0fa56-f7ac-40ab-8e19-997b97ab0994", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e654125-c50c-4b7b-8844-94d6905b2f70", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3e511e3-bfe5-481b-96ae-bad0e6609ced", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11db685c-1da5-4f9b-b6a2-ead53b7ecb6e", "name": "Update a variation option", "request": { "name": "Update a variation option", "description": {}, "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID", "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID", "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation-option\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {\n \"description\": \"Our most popular color\",\n \"name\": \"Blue\",\n \"sort_order\": 0\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d9178896-7932-4b5f-abb3-7dbc5269dc72", "name": "Successfully returns the updated variation option", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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 \"data\": {\n \"type\": \"product-variation-option\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {\n \"description\": \"Our most popular color\",\n \"name\": \"Blue\",\n \"sort_order\": 0\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"product-variation-option\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {\n \"description\": \"Our most popular color\",\n \"name\": \"Blue\",\n \"sort_order\": 0\n },\n \"meta\": {\n \"owner\": \"store\",\n \"created_at\": \"2024-01-25T11:25:38.001Z\",\n \"updated_at\": \"2024-01-25T11:25:38.001Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54a983de-540c-4725-8d1c-29e1162e388f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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 \"data\": {\n \"type\": \"product-variation-option\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {\n \"description\": \"Our most popular color\",\n \"name\": \"Blue\",\n \"sort_order\": 0\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44b3c547-c508-41c3-b84d-cc4a3818ff72", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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 \"data\": {\n \"type\": \"product-variation-option\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {\n \"description\": \"Our most popular color\",\n \"name\": \"Blue\",\n \"sort_order\": 0\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7de5a6b9-b474-4099-b0bd-30c7141046a5", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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 \"data\": {\n \"type\": \"product-variation-option\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {\n \"description\": \"Our most popular color\",\n \"name\": \"Blue\",\n \"sort_order\": 0\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69a1d0e2-c0e1-41b8-8b05-85ec9ff4beda", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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 \"data\": {\n \"type\": \"product-variation-option\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {\n \"description\": \"Our most popular color\",\n \"name\": \"Blue\",\n \"sort_order\": 0\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea8ea184-8bd2-4ce6-97c8-2cdbfbd14b24", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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 \"data\": {\n \"type\": \"product-variation-option\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {\n \"description\": \"Our most popular color\",\n \"name\": \"Blue\",\n \"sort_order\": 0\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf6a67aa-6e9d-4f0f-8ac9-504703252dc0", "name": "Delete a variation option", "request": { "name": "Delete a variation option", "description": {}, "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID", "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID", "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "138e8ffb-0105-4795-a9ac-5f86968c047e", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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": "0228c253-f3a6-4a44-84d8-67f178e1855d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c1a26b4-97ab-46d2-92d5-2f6934b2809d", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65b90a9b-65d0-4c60-a07d-b7fbefa4d85c", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a015f19-8007-451f-ad75-f98b43a02444", "name": "Create a modifier", "request": { "name": "Create a modifier", "description": { "content": "You can specify different modifiers for different options in a variation. When you build child products using options in variations, the properties of a child products depends on the modifier set for the options that are applied to the child product.\n \nThe table below describes the different types of modifiers.\n\n| Modifier | Data Type | Effect |\n| :--- | :--- | :--- |\n| `name_equals` | `string` | Overrides the name of the child product with the name specified by the modifier. |\n| `name_append` | `string` | Appends the string specified in the modifier to the name of the child product. |\n| `name_prepend` | `string` | Prepends the string specified in the modifier to the name of the child product. |\n| `description_equals` | `string` | Overrides the description of the child product. |\n| `description_append` | `string` | Appends the string specified in the modifier to the description of the child product. |\n| `description_prepend` | `string` | Prepends the string specified in the modifier to the product description of the child product. |\n| `commodity_type` | `string` | Sets the commodity type of the child product, such as `physical` or `digital`. |\n| `price` | `string` | Allows application of price modifiers (`price_increment`, `price_decrement`, and `price_equals`) to the child products. |\n| `price_increment` | `string` | Increases the price of the child product. |\n| `price_decrement` | `string` | Decreases the price of the child product. |\n| `price_equals` | `string` | Sets the price of a child product to the amount you specify. |\n| `slug_append` | `string` | Appends the string specified in the modifier to the slug of the child product. Can only contain A-Z, a-z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed. However, for the `slug-builder` modifier, you can use `{}` in the `seek` field, for example, `\"seek\": :{COLOR}\"`. |\n| `slug_prepend` | `string` | Prepends the string specified in the modifier to the slug of the child product. Can only contain A-Z, a-z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed. However, for the `slug-builder` modifier, you can use `{}` in the `seek` field, for example, `\"seek\": :{COLOR}\"`. |\n| `slug_builder` | `string`| Sets a part of the slug of the child product. Can only contain A-Z, a-z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed. However, for the `slug-builder` modifier, you can use `{}` in the `seek` field, for example, `\"seek\": :{COLOR}\"`. |\n| `sku_equals` | `string` | Sets the SKU of the child product. |\n| `sku_append` | `string` | Appends the string specified in the modifier to the SKU of the child product. |\n| `sku_prepend` | `string` | Prepends the string specified in the modifier to the SKU of the child product. |\n| `sku_builder` | `string` | Sets a part of the SKU of the child product. |\n| `status` | `string` | Sets the status of the child product, such as `draft` or `live`. |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID", "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID", "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation-modifier\",\n \"attributes\": {\n \"seek\": \"{color}\",\n \"set\": \"red\",\n \"type\": \"slug_builder\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c955922a-9d51-4931-9f52-33665e775844", "name": "Successfully returns the created modifier", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation-modifier\",\n \"attributes\": {\n \"seek\": \"{color}\",\n \"set\": \"red\",\n \"type\": \"slug_builder\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"product-variation-modifier\",\n \"id\": \"a510cddc-e946-4c22-9541-54626a7cf0ec\",\n \"attributes\": {\n \"seek\": \"{color}\",\n \"set\": \"red\",\n \"type\": \"slug_builder\"\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "231610d4-3a3e-4e03-9d4c-681df836010c", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation-modifier\",\n \"attributes\": {\n \"seek\": \"{color}\",\n \"set\": \"red\",\n \"type\": \"slug_builder\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85c3eac4-6681-4031-993f-b9a3cd92a1c7", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation-modifier\",\n \"attributes\": {\n \"seek\": \"{color}\",\n \"set\": \"red\",\n \"type\": \"slug_builder\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3976cff0-e8cd-49e9-9f38-f450a3958b46", "name": "Get all modifiers", "request": { "name": "Get all modifiers", "description": {}, "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID", "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID", "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7307fea1-34ea-420e-a1c1-c3c0f8319f33", "name": "Successfully returns all variation modifiers.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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 \"type\": \"product-variation-modifier\",\n \"id\": \"68ec4892-9e4c-4154-a9fd-f5a9fb1f6878\",\n \"attributes\": {\n \"type\": \"sku_equals\",\n \"value\": \"newSku\"\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n },\n {\n \"type\": \"product-variation-modifier\",\n \"id\": \"a510cddc-e946-4c22-9541-54626a7cf0ec\",\n \"attributes\": {\n \"seek\": \"{color}\",\n \"set\": \"red\",\n \"type\": \"slug_builder\"\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n },\n {\n \"type\": \"product-variation-modifier\",\n \"id\": \"2f0cbb06-8880-4a75-bfc6-a20f0f73a997\",\n \"attributes\": {\n \"reference_name\": \"PriceEqual\",\n \"type\": \"price\"\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 3\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f94b9030-a9c2-416a-a989-c586dc4d02e8", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "324672d2-4f65-486f-b5d7-965af0514bad", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "962a9749-1f2e-4cef-a659-7a8a6610fa5c", "name": "Get a modifier", "request": { "name": "Get a modifier", "description": {}, "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID", "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID", "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID", "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "efc2bb7e-5e26-46a0-8a24-858a8583a494", "name": "Returns the specified modifier.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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 \"type\": \"product-variation-modifier\",\n \"id\": \"68ec4892-9e4c-4154-a9fd-f5a9fb1f6878\",\n \"attributes\": {\n \"type\": \"sku_equals\",\n \"value\": \"newSku\"\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "448ddd32-673f-4062-a84f-4b922abedca7", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8444c90d-7ac0-4827-8faa-bb45cc8b4087", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8879a3be-0aca-412c-9f62-9c7c82926a32", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4d67c1d7-a349-4c44-9270-0150cf64b93a", "name": "Update a modifier", "request": { "name": "Update a modifier", "description": { "content": "Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the modifier is not updated.", "type": "text/plain" }, "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID", "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID", "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID", "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-variation-modifier\",\n \"id\": \"68ec4892-9e4c-4154-a9fd-f5a9fb1f6878\",\n \"attributes\": {\n \"type\": \"sku_equals\",\n \"value\": \"anotherSku\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6bc9c726-3896-4582-8da6-832281d71327", "name": "Successfully returns the updated modifier.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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 \"data\": {\n \"type\": \"product-variation-modifier\",\n \"id\": \"68ec4892-9e4c-4154-a9fd-f5a9fb1f6878\",\n \"attributes\": {\n \"type\": \"sku_equals\",\n \"value\": \"anotherSku\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"product-variation-modifier\",\n \"id\": \"68ec4892-9e4c-4154-a9fd-f5a9fb1f6878\",\n \"attributes\": {\n \"type\": \"sku_equals\",\n \"value\": \"newSku\"\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6acb911-f52c-438c-99cd-de5fb855d595", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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 \"data\": {\n \"type\": \"product-variation-modifier\",\n \"id\": \"68ec4892-9e4c-4154-a9fd-f5a9fb1f6878\",\n \"attributes\": {\n \"type\": \"sku_equals\",\n \"value\": \"anotherSku\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cc1cf3e-cbc9-423b-80da-526c40a98ad9", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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 \"data\": {\n \"type\": \"product-variation-modifier\",\n \"id\": \"68ec4892-9e4c-4154-a9fd-f5a9fb1f6878\",\n \"attributes\": {\n \"type\": \"sku_equals\",\n \"value\": \"anotherSku\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71af8075-e8f1-4286-b241-b0452cb68cf1", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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 \"data\": {\n \"type\": \"product-variation-modifier\",\n \"id\": \"68ec4892-9e4c-4154-a9fd-f5a9fb1f6878\",\n \"attributes\": {\n \"type\": \"sku_equals\",\n \"value\": \"anotherSku\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cb76421-dceb-4ef0-84fc-8bea7e12e234", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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 \"data\": {\n \"type\": \"product-variation-modifier\",\n \"id\": \"68ec4892-9e4c-4154-a9fd-f5a9fb1f6878\",\n \"attributes\": {\n \"type\": \"sku_equals\",\n \"value\": \"anotherSku\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d9541f3-bee0-42c4-b2a5-2cce5f47cf55", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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 \"data\": {\n \"type\": \"product-variation-modifier\",\n \"id\": \"68ec4892-9e4c-4154-a9fd-f5a9fb1f6878\",\n \"attributes\": {\n \"type\": \"sku_equals\",\n \"value\": \"anotherSku\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d88f83e-fb63-4862-93df-fd609f399e30", "name": "Delete a modifier", "request": { "name": "Delete a modifier", "description": { "content": "You cannot delete a modifier if it is in use. Deleting a modifier in us returns a `422 Failed Validation` error.", "type": "text/plain" }, "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID", "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID", "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID", "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "0c7eaa31-6ae4-42e6-8ff7-4e771df039d0", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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": "670a620b-0cd8-4a92-b176-c110813afe48", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "827670af-800e-4002-8cd3-e96de061bf1a", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "815a206f-fd2c-4b2e-a1ad-1ea2d1679a5a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "variations", ":variationID", "options", ":optionID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the variation.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "variationID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the option.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "optionID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the modifier.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "modifierID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Product File Relationships", "description": "Products are the items or services that you might want to sell in your store. In Product Experience Manager, products can also have associated rich media assets, such as product images or a file containing additional product details.\n\nYou can do this using [Files API](/docs/api/pxm/files).\n\nOnce you have created your files, you associate files with your products using the [Create Product-File Relationships API](/docs/api/pxm/products/create-product-file-relationships).\n", "item": [ { "id": "98cbe7f9-3b75-4788-a644-f2b0fdc385f0", "name": "Get all product file relationships", "request": { "name": "Get all product file relationships", "description": { "content": "Retrieves all files that are associated with the specified product.", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8f8f08ff-62d2-4a83-9c5e-d2f3193ff91d", "name": "Returns all product file relationships.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c58bebdd-65cc-4188-a88d-dc0adf83e9aa", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44498428-2c57-4312-b617-8c82a700e60c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "139aa4a1-60a3-4b1f-9850-41a0f42b0309", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2b30b73-34f0-4a43-b564-f5823df8fc77", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72496580-a90a-4704-9fa8-7d01687ae509", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a34fa8ea-7f0e-4d4d-938b-67214c1e898b", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "efd47bad-8319-41c3-813a-4d0433ac4dad", "name": "Create a product file relationship", "request": { "name": "Create a product file relationship", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "993a843b-e6e6-4d2a-ba65-fbed379c67bd", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "header": [ { "key": "Content-Type", "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "366760d2-dbb5-4b7b-b9f5-4ad44e59ed40", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a1ad975-1e0b-4b27-a865-a789cc3f1d8f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5be83831-3130-49d5-a961-5f4d4912071a", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe797b4a-a597-4750-bd4c-8f38ad57f515", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b7710de-8d98-4513-8e3b-55c21cbf655a", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0085cb5e-d3b7-470e-b062-9b91b7fb1400", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10d3edbb-eebd-44ae-b789-245eb6c9cdca", "name": "Replace a product file relationship", "request": { "name": "Replace a product file relationship", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bd79e6c6-d08b-4591-ab37-3f45ae067b8d", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "header": [ { "key": "Content-Type", "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95a4b197-0633-4b60-8e80-36c28d7edcf1", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58d82d4a-17b0-45bf-a4b3-2bb5d1f81fb2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "387b90b2-8f79-4cd5-80f9-8c6d15fce387", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f336da0a-548f-4692-8e26-08004b861064", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16190a4b-b42b-4f85-bb21-6d0e83906c6e", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98176bdd-4c08-43e9-bc22-037388973834", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c09c73b-7b82-4844-9872-5660a2ff44f9", "name": "Delete a product file relationships", "request": { "name": "Delete a product file relationships", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e2510aa2-2451-4ed1-a3a6-aef3a67371a9", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "122f460f-108f-42da-8cee-fddf4890a0ed", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f100ca57-c68c-457a-8359-8e6b5fa0719f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df7462d8-e0bb-4e6f-ad4e-ad2c4227a5b2", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc9c8d39-32f3-4ec3-bd85-54cb200c0ba0", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58224140-1963-42da-95a8-5f9373d459aa", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a066272-d19e-47d5-9c3f-e1dc0de45190", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"43903bfa-5352-4a3d-9496-c9ab1229a175\",\n \"type\": \"file\"\n },\n {\n \"id\": \"50f56ce9-9381-43f6-8a52-5369a8b42e52\",\n \"type\": \"file\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Product Image Relationships", "description": "Products are the items or services that you might want to sell in your store. In Product Experience Manager, products can also have associated rich media assets, such as product images or a file containing additional product details.\n\nYou can do this using [Files API](/docs/api/pxm/files).\n\nOnce you have created your files, you associate files with your products using the [Create Product Main Image Relationships API](/docs/api/pxm/products/create-product-main-image-relationships).\n", "item": [ { "id": "a6a4a856-587e-428e-b6f5-66f40c962228", "name": "Create main image relationships", "request": { "name": "Create main image relationships", "description": { "content": "Associates a main image with the specified product.", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fbf969d0-9e90-4267-98a9-17f1463eda5f", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "header": [ { "key": "Content-Type", "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 \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6b9aa06c-3121-4900-8b81-f0ef71b024f9", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a15e2203-2b9d-45f1-a592-ea16e562ab1f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adb8087a-457c-436e-9c53-583f08b24a23", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98d023e6-08b0-4a66-a32c-cbe1edc848a9", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31c01080-d03a-44e6-8946-968e29e59af7", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da944a41-9892-4651-9a99-bad1b78efda3", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6e76fd7-3c58-4e0a-b1ef-9d29241cd967", "name": "Get Main Image Relationships", "request": { "name": "Get Main Image Relationships", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "833a963e-f94e-4a5b-94f8-175d960c46d2", "name": "Returns all product variation relationships", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"type\": \"file\",\n \"id\": \"file-1\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d075ff1-1a93-4be5-be06-55c03f32fafb", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66bed362-e66b-44c1-af61-caf924225957", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9626164-95e3-4430-a7d8-6ca1cf7d22ae", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d79a5db9-8a22-47ed-a191-fe51091db6b3", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5177e99-ce85-439d-8d3a-04da8ba6555b", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6aae9f2e-d324-43ca-9be8-8776d79c2a7d", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5bcd819d-f200-4085-b98b-5ffa55346f34", "name": "Replace Main Image Relationships", "request": { "name": "Replace Main Image Relationships", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ae67dbec-d0dd-429a-b57b-fb98718cd155", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "header": [ { "key": "Content-Type", "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 \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "254b30e2-9317-457f-ae67-33a624a3146b", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83870f70-27e9-4265-8a66-b3d3acb8384e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b37ac9a-3b34-4303-8939-09e63b5a745b", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9317066e-ad4c-45d7-96b1-6e94babb2792", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55635ee5-159f-48e0-8a54-917d9c65ac87", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "050dc8d2-d8bf-455d-bdf5-7e6b583dd5ed", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"data\": {\n \"type\": \"file\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "423fe0e9-2db7-41a9-adea-dc38e9ee9cbe", "name": "Delete Main Image Relationships", "request": { "name": "Delete Main Image Relationships", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "2f1007d7-3b29-4f88-b066-dcc58d03a510", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "24ecf18a-855f-4ba9-bf3c-81be3dd2af58", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8c97511-a101-44cb-a060-3b7b7a791261", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff86f71b-e865-479d-8f84-696e62275cc3", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d93f5ed7-64c8-4ac7-bf96-9a8c6d30b091", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a19e795-3bfb-42e8-98ab-77c486555e6f", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28eb5703-7f86-4a4e-a6bf-2fd78cc1c3b6", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "relationships", "main_image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Product Import/Bulk Update", "description": "```mdx-code-block\nimport ProductImport from '/docs/partials/pxm/import/import.mdx';\n\n\n```\n\n#### Using Imported Main Image Files\n\nYou can use the main images that you have previously uploaded to Commerce and assign them to your products when importing products to Commerce. You can do this by adding a `main_image_id` header to your `.csv` file. The ID you provide in `main_image_id` is the ID of a file that has already been uploaded to Commerce using create a file.\n\n#### Importing Custom Data (Flows)\n\nYou can also create/update custom extension data in a `.csv` file by creating a header that includes the flow `ID` and the field `slug` in the following format: \n\ntemplate:*flowID*:*fieldSlug*.\n\nwhere:\n\n- `template` must be `template`.\n- `flowID` is the ID of the flow that contains the field whose data you want to create/update.\n- `fieldSlug` is the slug of the field whose data you want to create/update.\n\nIn the following example, for a flow with ID `82c10a02-1851-4992-8ecb-d44f2782d09b` and a field with the slug `condition`:\n\n- the header is `template:82c10a02-1851-4992-8ecb-d44f2782d09b:condition`.\n- the updated custom data is `as-new`.\n\n | name | slug | sku | status | template:82c10a02-1851-4992-8ecb-d44f2782d09b:condition |\n | :--- | :--- | :--- | :--- | :--- |\n | BestEver Range | bestever-range-1a1a-30 | BE-Range-1a1a-30 | draft | as-new |\n\n#### Characteristics of CSV Import Files\n\nProduct Import uses a [**Comma Separated Values (CSV)**](#characteristics-of-csv-import-files) file to import/update products, main image files, and custom extension data. \n\n- Each row in a `.csv` file represents a product you want to create/update. \n- Each file:\n - must not be larger than 50 megabytes. If a `.csv` file is larger than 50 megabytes, a `503 client read error` is displayed.\n - must not have more than 50,000 rows, including the header. If a CSV file exceeds 50,000 rows, an error is displayed, and the products are not imported.\n In other words, if you have a file with 50,000 rows that is larger than 50 megabytes, an error is displayed, and the products are not imported.\n- If you want to create/update more than 50,000 products or your `.csv` file is larger than 50 megabytes, you must have a separate `.csv` file and import each `.csv` file one at a time.\n- You can update existing products, including images, templates/flow fields, and entries. The entry in the `.csv` file must have a unique `id` and/or `external_ref` that matches the `id` and `external_ref` of the existing product you want to update. You may have both a unique `id` and `external_ref`, but you must have at least one.\n- You can add new products. For new products that you want to add, the entry in the `.csv` file must have an `external_ref` that does not match any existing products.\n\nThe following table describes the headers that are supported.\n\n| Header | Required | Description |\n|:---- |:---------|:--|\n| id | Optional | A unique product ID that is generated when you create the product. The `id` is used to look up products in the `.csv` file and matches them to the products in your storefront that you want to update. |\n| external_ref | Optional | A unique attribute associated with a product. This could be an external reference from a separate company system, for example. The maximum length is 2048 characters. |\n| name | Required | The name of a product. |\n| description | Required | A description for a product. You can include quotes in your product description, if you want to emphasize a word, for example. To do this, put quotes around the product description. For example, \"This product description describes my \"product\" and the product \"version\".\" |\n| slug | Required | A label for the product that is used in the URL paths. A slug can contain any combination of letters, numbers, periods, hyphens, and underscores. NO spaces or other characters are allowed. By default, the product name is used as the slug. |\n| status | Required | The status of a product, either `Draft` or `Live`. |\n| commodity_type | Required | The commodity type, either `physical` or `digital`. |\n| upc_ean | Optional | The universal product code or european article number of the product. |\n| mpn | Optional | The manufacturer part number of a product. |\n| sku | Optional | The unique stock keeping unit of the product. |\n| tags | Optional | The product tags used to store or assign a key word against a product. A product can have up to 20 product tags. A product tag can be up to 255 characters. See [**Product Tags**](/docs/api/pxm/products/product-tags).\n| main_image_id | Optional | Specifies a unique ID of a main image file for a product. You can include a `main_image_id` for your products for images that are already uploaded to Commerce. See [**Using Main Image Files**](#importing-custom-data-flows). |\n| `template::` | Optional | You can also specify custom extension data in the CSV by specifying the flow `ID` or `slug` and the field `name`. For example, `template::` format. See [**Importing Custom Data (Flows)**](#importing-custom-data-flows). |\n", "item": [ { "id": "042f3025-7b44-4366-9f3d-d0610916ca36", "name": "Import Products", "request": { "name": "Import Products", "description": { "content": "\nYou can use the Product Import API to:\n\n- Add new products, including:\n\n - main image files. See [Importing Main Image Files](/docs/api/pxm/products/product-import-bulk-update#using-imported-main-image-files).\n - custom data. See [Importing custom data](/docs/api/pxm/products/product-import-bulk-update#importing-custom-data-flows).\n - Make bulk updates to existing products.\n\nYou cannot use product import to:\n\n- Delete existing products.\n- Import product bundles.\n\nThe Product Import API uses a Comma Separated Values (CSV) file to import products, main image files, custom extension data, and admin and shopper attributes. Each row in a .csv file represents a product you want to create/update. See an [example file](/assets/pim_product_import_example.csv).\n\nEach file can have 50,000 rows, including the header. If a CSV file exceeds 50,000 rows, an error is displayed, and the products are not imported. A CSV file must not be larger than 50 megabytes. If a CSV file is larger than 50 megabytes, a `503 client read` error is displayed.\n\nIf you want to create/update more than 50,000 products or your CSV file is larger than 50 megabytes, you must have a separate CSV file and import each CSV file one at a time.\n\nSee [**Characteristics of CSV Files**](/docs/api/pxm/products/product-import-bulk-update#characteristics-of-csv-import-files).\n\n## Custom Attributes in CSV\n\nYou can set custom attributes on products using CSV columns with the prefixes `shopper_attributes.` or `admin_attributes.` followed by the attribute key name. For example:\n\n- `shopper_attributes.color` sets the `color` key on `shopper_attributes`.\n- `admin_attributes.cost_of_goods` sets the `cost_of_goods` key on `admin_attributes`.\n\n**Partial updates:** When updating an existing product, only the attribute keys present as columns in the CSV are affected. Attribute keys not included as columns are left unchanged.\n\n**Removing an attribute key:** To explicitly delete an attribute key from an existing product, set the cell value to `__REMOVE_ATTRIBUTE__`. This special sentinel value instructs the importer to remove that key from the product's custom attributes. An empty cell value is treated as a literal empty string, not a deletion.\n\n**New products:** For new products being created via import, any column whose value is `__REMOVE_ATTRIBUTE__` is ignored (the key is not created).\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products", "import" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the locale to assist in parsing flow entry date values.\n\n- If a supported locale is provided, the system attempts to interpret dates using that locale's conventions. The import job fails if a date does not match one of the supported locale's formats.\n- If this parameter is omitted, or if the value provided is not on the supported list, the system proceeds using its default parsing logic. An unsupported locale is ignored and does not cause a failure.\n\n**Supported Locales and Date Formats:**\n\n**`en-US`**\n- `1/2/2006 15:04:05`\n- `01/02/2006 15:04:05`\n- `1/2/06 15:04`\n\n**`en-GB`**\n- `2/1/2006 15:04:05`\n- `02/01/2006 15:04:05`\n- `2/1/06 15:04`\n\n**`en-CA`**\n- `2/1/2006 15:04:05`\n- `02/01/2006 15:04:05`\n- `2/1/06 15:04` \n\nAdditional locales and date formats can be added upon request.\n (This can only be one of en-US,en-GB,en-CA)", "type": "text/plain" }, "key": "locale", "value": "en-US" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "The file you want to upload. Ensure that the file format is Comma Separated Values (CSV).", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": null }, "response": [ { "id": "81a947a4-518b-4976-b849-fa7d825d797d", "name": "Import started", "originalRequest": { "url": { "path": [ "pcm", "products", "import" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the locale to assist in parsing flow entry date values.\n\n- If a supported locale is provided, the system attempts to interpret dates using that locale's conventions. The import job fails if a date does not match one of the supported locale's formats.\n- If this parameter is omitted, or if the value provided is not on the supported list, the system proceeds using its default parsing logic. An unsupported locale is ignored and does not cause a failure.\n\n**Supported Locales and Date Formats:**\n\n**`en-US`**\n- `1/2/2006 15:04:05`\n- `01/02/2006 15:04:05`\n- `1/2/06 15:04`\n\n**`en-GB`**\n- `2/1/2006 15:04:05`\n- `02/01/2006 15:04:05`\n- `2/1/06 15:04`\n\n**`en-CA`**\n- `2/1/2006 15:04:05`\n- `02/01/2006 15:04:05`\n- `2/1/06 15:04` \n\nAdditional locales and date formats can be added upon request.\n (This can only be one of en-US,en-GB,en-CA)", "type": "text/plain" }, "key": "locale", "value": "en-US" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "The file you want to upload. Ensure that the file format is Comma Separated Values (CSV).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"pim-job\",\n \"id\": \"7e1b9ba1-c844-4556-9b16-4ae3f0988b0f\",\n \"attributes\": {\n \"completed_at\": null,\n \"created_at\": \"2024-01-05T15:27:23.161Z\",\n \"started_at\": null,\n \"status\": \"pending\",\n \"type\": \"product-import\",\n \"updated_at\": \"2024-01-05T15:27:23.161Z\"\n },\n \"meta\": {\n \"x_request_id\": \"fad8c5c0-9546-4e0c-b68e-8a2d809891e5\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "009d7723-4b85-448d-b2c4-15f1d31f240c", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", "import" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the locale to assist in parsing flow entry date values.\n\n- If a supported locale is provided, the system attempts to interpret dates using that locale's conventions. The import job fails if a date does not match one of the supported locale's formats.\n- If this parameter is omitted, or if the value provided is not on the supported list, the system proceeds using its default parsing logic. An unsupported locale is ignored and does not cause a failure.\n\n**Supported Locales and Date Formats:**\n\n**`en-US`**\n- `1/2/2006 15:04:05`\n- `01/02/2006 15:04:05`\n- `1/2/06 15:04`\n\n**`en-GB`**\n- `2/1/2006 15:04:05`\n- `02/01/2006 15:04:05`\n- `2/1/06 15:04`\n\n**`en-CA`**\n- `2/1/2006 15:04:05`\n- `02/01/2006 15:04:05`\n- `2/1/06 15:04` \n\nAdditional locales and date formats can be added upon request.\n (This can only be one of en-US,en-GB,en-CA)", "type": "text/plain" }, "key": "locale", "value": "en-US" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "The file you want to upload. Ensure that the file format is Comma Separated Values (CSV).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd803f57-dbd4-4bca-b82c-42bce2ec7438", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", "import" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the locale to assist in parsing flow entry date values.\n\n- If a supported locale is provided, the system attempts to interpret dates using that locale's conventions. The import job fails if a date does not match one of the supported locale's formats.\n- If this parameter is omitted, or if the value provided is not on the supported list, the system proceeds using its default parsing logic. An unsupported locale is ignored and does not cause a failure.\n\n**Supported Locales and Date Formats:**\n\n**`en-US`**\n- `1/2/2006 15:04:05`\n- `01/02/2006 15:04:05`\n- `1/2/06 15:04`\n\n**`en-GB`**\n- `2/1/2006 15:04:05`\n- `02/01/2006 15:04:05`\n- `2/1/06 15:04`\n\n**`en-CA`**\n- `2/1/2006 15:04:05`\n- `02/01/2006 15:04:05`\n- `2/1/06 15:04` \n\nAdditional locales and date formats can be added upon request.\n (This can only be one of en-US,en-GB,en-CA)", "type": "text/plain" }, "key": "locale", "value": "en-US" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "The file you want to upload. Ensure that the file format is Comma Separated Values (CSV).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f584fdbc-14c9-4514-9d9a-dbfd6ada8f18", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", "import" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the locale to assist in parsing flow entry date values.\n\n- If a supported locale is provided, the system attempts to interpret dates using that locale's conventions. The import job fails if a date does not match one of the supported locale's formats.\n- If this parameter is omitted, or if the value provided is not on the supported list, the system proceeds using its default parsing logic. An unsupported locale is ignored and does not cause a failure.\n\n**Supported Locales and Date Formats:**\n\n**`en-US`**\n- `1/2/2006 15:04:05`\n- `01/02/2006 15:04:05`\n- `1/2/06 15:04`\n\n**`en-GB`**\n- `2/1/2006 15:04:05`\n- `02/01/2006 15:04:05`\n- `2/1/06 15:04`\n\n**`en-CA`**\n- `2/1/2006 15:04:05`\n- `02/01/2006 15:04:05`\n- `2/1/06 15:04` \n\nAdditional locales and date formats can be added upon request.\n (This can only be one of en-US,en-GB,en-CA)", "type": "text/plain" }, "key": "locale", "value": "en-US" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "The file you want to upload. Ensure that the file format is Comma Separated Values (CSV).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Product Export", "description": "```mdx-code-block\nimport ProductExport from '/docs/partials/pxm/import/export.mdx';\n\n\n```\n\n### Characteristics of Exporting Products\n\n- Product exports are an asynchronous operation. When you send a request to the Export API, it triggers an asynchronous job to build the `.csv` file containing the product entries.\n- Jobs are processed one at a time. You can continue to send product export requests, but those jobs are queued. In other words, Commerce looks for any jobs that have a status of PENDING and starts the job with the earliest created date. This process is repeated until all jobs are processed. See [**Jobs**](/docs/api/pxm/products/jobs).\n- The Export API response includes a job resource. In the response, you can verify the job status; if the status is successful, the response includes a link to the location where the `.csv` file is stored. See [**Product Export CSV File**](#product-export-csv-file). A single CSV file contains 10,000 rows, excluding the header. If you are exporting 50,000 products, the job endpoint response contains links to five `.csv` files; each `.csv` file including 10,000 products.\n- You might have specified custom extension data in a `.csv` file when you imported the products. These modifications are all exported. So, when you send a request to the Export API, the `.csv` file, included in the Job endpoint response, reflects any changes that you have made.\n- You cannot export product bundles.\n\n### Product Export CSV File\n\nThe Product Export API generates a Comma Separated Values (CSV) file that you can use to import/update products, main image files, and custom extension data. \n\nThe `.csv` file is:\n\n - Comma-separated.\n - Header-based.\n - Header attributes must be the same as the product attributes.\n - Header names can be in any order.\n - Each row after the first line represents a single product.\n\nThe following table describes the headers that are supported.\n\n| Header | Required | Description | \n|:---------------------------------|:---------|:-----------------------------------------------------|\n| id | Optional | A unique product ID that is generated when you create the product. The `id` is used to look up products in the `.csv` file and matches them to the products in your storefront that you want to update. |\n| external_ref | Optional | A unique attribute associated with a product. This could be an external reference from a separate company system, for example. The maximum length is 2048 characters. | \n| name | Required | The name of a product. | \n| description | Required | A description for a product. You can include quotes in your product description, if you want to emphasize a word, for example. To do this, put quotes around the product description. For example, \"This product description describes my \"product\" and the product \"version\".\" |\n| slug | Required | A label for the product that is used in the URL paths. A slug can contain any combination of letters, numbers, periods, hyphens, and underscores. NO spaces or other characters are allowed. By default, the product name is used as the slug. |\n| status | Required | The status of a product, either `Draft` or `Live`. | \n| commodity_type | Required | The commodity type, either `physical` or `digital`. | \n| upc_ean | Optional | The universal product code or european article number of the product. | \n| mpn | Optional | The manufacturer part number of a product. | \n| sku | Optional | The unique stock keeping unit of the product. | \n| tags | Optional | The product tags used to store or assign a key word against a product. A product can have up to 20 product tags. A product tag can be up to 255 characters. See [**Product Tags**](/docs/api/pxm/products/product-tags\n). |\n| main_image_id | Optional | Specifies a unique ID of a main image file for a product. See [Exporting Main Image Files](#exporting-main-image-files). | \n| `_created_at` | Optional| The date and time a product was created. **Note**: This field does not populate any data; it is provided solely for informational purposes. | \n| `_updated_at` | Optional | The date and time a product was updated. **Note**: This field does not populate any data; it is provided solely for informational purposes. | \n| `template::created_at` | Optional | The date and time a template was created. **Note**: This field does not populate any data; it is provided solely for informational purposes. | \n| `template::updated_at` | Optional | The date and time a template was updated. **Note**: This field does not populate any data; it is provided solely for informational purposes. | \n| `template::` | Optional | Custom extension data includes the flow `ID` or `slug` and the field `name`. See [Exporting Custom Data (Flows)](#exporting-custom-data-flows). | \n\n### Exporting Main Image Files\n\nThe main images that you have previously uploaded Commerce are exported. A `main_image_id` header is added to your `.csv` file. The ID in `main_image_id` is the ID of a file that has already been uploaded to Commerce using [create a file](/docs/api/pxm/files/create-a-file).\n\n### Exporting Custom Data (Flows)\n\nCustom extension data is exported in a `.csv` file by creating a header that includes the flow `ID` or `slug` and the field `name` as shown below:\n\n- `template::`\n- `template::`\n\nwhere:\n\n- `template` must be `template`.\n- one of the following for the template that contains the field whose data you want to export:\n - `flowID` is the ID of the flow.\n - `flowSlug` is the flow slug.\n- `fieldName` is the name of the field whose data you want to export.\n\nIn the following example, for a flow with ID `82c10a02-1851-4992-8ecb-d44f2782d09b` and a field with the name `condition`:\n\n- the header is `template:82c10a02-1851-4992-8ecb-d44f2782d09b:condition`.\n- the updated custom data is `as-new`.\n\n| name | slug | sku | status | template:82c10a02-1851-4992-8ecb-d44f2782d09b:condition |\n| :--- | :--- | :--- | :--- | :--- |\n| BestEver Range | bestever-range-1a1a-30 | BE-Range-1a1a-30 | draft | as-new |\n", "item": [ { "id": "78df188c-b00c-4972-a18e-40e5e819ac05", "name": "Export Products", "request": { "name": "Export Products", "description": { "content": "\nThe Export API is available to make bulk updates to products in Product Experience Manager. You might also export products for your personal requirements. \n \nThe Export API builds a CSV file containing the product entries. A CSV file can contain up to 50,000 product entries. If you have more than 50,000 product entries, then another CSV file is created and so on, until all your products are exported.\n\nThe Job endpoint response specifies the location where the CSV file is stored. See [Characteristics of CSV Files](/docs/api/pxm/products/product-export#characteristics-of-exporting-products).\n\n### Custom Attributes in Exported CSV\n\nExported CSV files include custom attribute columns using the prefixes `shopper_attributes.` and `admin_attributes.` followed by the attribute key name. For example, a product with `admin_attributes: {cost_of_goods: \"42.0\"}` produces a column `admin_attributes.cost_of_goods` in the exported file.\n\nYou can select specific attribute columns to include in the export using the `columns.include` parameter. You may specify individual keys (for example, `admin_attributes.cost_of_goods`) or use a wildcard to include all keys of a given type (for example, `admin_attributes.*`). You cannot combine a wildcard and individual keys for the same attribute type in a single export request.\n\n### Exporting Selected Columns\nProduct exports support the ability to select a subset of columns to be included in the generated .csv file. This allows you to export only the data you need, making it easier to work with smaller, more focused datasets.\n\n To specify the columns you want to include in the export, use the columns.include parameter in the request body of this endpoint. This parameter accepts an array of strings, where each string represents the name of a product attribute or a flow field.\n\n #### Specifying Flow Field Columns:\n \n The format for specifying flow field columns depends on the useTemplateSlugs setting:\n \n * useTemplateSlugs: `true`: Specify flow field columns using the format: `products():`. For example: `products(my_flow):my_field`.\n * useTemplateSlugs: `false` (default): Specify flow field columns using the format: `template::`. For example: `template:82c10a02-1851-4992-8ecb-d44f2782d09b:my_field`.\n \n #### Mandatory Fields:\n\n To ensure successful re-importing of product data, the following fields are always included in the export, regardless of the columns.include parameter:\n \n * id\n * name\n * sku\n * external_ref\n * commodity_type\n \n If the `columns.include` parameter is not provided in the request, the system will export all available product fields.\n \n ### Filtering\n \nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description | Example |\n | :------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------------------------------------------- |\n | `eq` | `id`, `sku`, `slug`, `upc_ean`, `manufacturer_part_num`, `name`, `templates`, `commodity_type`, `owner`, `product_types`, `parent_id`, `component_option_id`, `tags`, `status`, `has_nodes (false only)`, `created_at`, `updated_at`, `external_ref`, `description` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. For `product_types`, you can only specify one product type. **Note:** `has_nodes` can only be filtered as `false`. **Note:** `component_option_id` matches when a bundle includes that product id as a component option. | `?filter=eq(name,some-name)` |\n | `like` | `sku`, `slug`, `upc_ean`, `manufacturer_part_num`, `name`, `tags`, `description`, `external_ref` | Like. Checks if the operand contains the specified string. Wildcards are supported. | `?filter=like(name,*some-name*)` |\n | `in` | `id`, `name`, `sku`, `slug`, `upc_ean`, `manufacturer_part_num`, `product_types`, `parent_id`, `component_option_id`, `tags`, `external_ref` | Checks if the values are included in the specified list. If they are, the condition is true. For `product_types`, you can specify more than one product type. | `?filter=in(id,some-id)` |\n | `gt` | `id`, `created_at`, `updated_at`, `external_ref` | Greater than. Checks if the value of the field is greater than the given value. | `?filter=gt(updated_at,2024-01-01T00:00:00Z)` |\n | `ge` | `id`, `created_at`, `updated_at`, `external_ref` | Greater than or equal to. Checks if the value of the field is greater than or equal to the given value. | `?filter=ge(created_at,2023-01-01T00:00:00Z)` |\n | `lt` | `id`, `created_at`, `updated_at`, `external_ref` | Less than. Checks if the value of the field is less than the given value. | `?filter=lt(updated_at,2025-01-01T00:00:00Z)` |\n | `le` | `id`, `created_at`, `updated_at`, `external_ref` | Less than or equal to. Checks if the value of the field is less than or equal to the given value. | `?filter=le(created_at,2022-01-01T00:00:00Z)` |\n | `eq` (extensions) | `extensions.book.isbn` | Filters using a nested extension field. | `?filter=eq(extensions.book.isbn,1765426)` |\n | `eq` (shopper_attributes) | `shopper_attributes.color` | Filters using a shopper custom attribute field. | `?filter=eq(shopper_attributes.color,red)` |\n | `eq` (admin_attributes) | `admin_attributes.warehouse` | Filters using an admin custom attribute field. | `?filter=eq(admin_attributes.warehouse,US-EAST)` |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `true` if you want to use a template slug instead of a template ID when exporting products that have custom data.", "type": "text/plain" }, "key": "useTemplateSlugs", "value": "false" }, { "disabled": false, "description": { "content": "\nMany Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.\n\nFor more information about the attributes and operators that this endpoint supports, see [Export Products](/docs/api/pxm/products/export-products).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-export\",\n \"attributes\": {\n \"columns\": {\n \"include\": [\n \"description\",\n \"template:a1b2c3d4-e5f6-7890-1234-567890abcdef:isbn\"\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6fd56e9a-537a-42ec-a310-607817dcf0df", "name": "Export started", "originalRequest": { "url": { "path": [ "pcm", "products", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `true` if you want to use a template slug instead of a template ID when exporting products that have custom data.", "type": "text/plain" }, "key": "useTemplateSlugs", "value": "false" }, { "disabled": false, "description": { "content": "\nMany Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.\n\nFor more information about the attributes and operators that this endpoint supports, see [Export Products](/docs/api/pxm/products/export-products).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-export\",\n \"attributes\": {\n \"columns\": {\n \"include\": [\n \"description\",\n \"template:a1b2c3d4-e5f6-7890-1234-567890abcdef:isbn\"\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"pim-job\",\n \"id\": \"7e1b9ba1-c844-4556-9b16-4ae3f0988b0f\",\n \"attributes\": {\n \"completed_at\": null,\n \"created_at\": \"2024-01-05T15:27:23.161Z\",\n \"started_at\": null,\n \"status\": \"pending\",\n \"type\": \"product-export\",\n \"updated_at\": \"2024-01-05T15:27:23.161Z\"\n },\n \"meta\": {\n \"file_locations\": null,\n \"filter\": \"eq(sku,product-1)\",\n \"x_request_id\": \"fad8c5c0-9546-4e0c-b68e-8a2d809891e5\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b63a6fd1-adbb-4009-87b7-7d8cb53cf229", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `true` if you want to use a template slug instead of a template ID when exporting products that have custom data.", "type": "text/plain" }, "key": "useTemplateSlugs", "value": "false" }, { "disabled": false, "description": { "content": "\nMany Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.\n\nFor more information about the attributes and operators that this endpoint supports, see [Export Products](/docs/api/pxm/products/export-products).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-export\",\n \"attributes\": {\n \"columns\": {\n \"include\": [\n \"description\",\n \"template:a1b2c3d4-e5f6-7890-1234-567890abcdef:isbn\"\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70d636f1-f90d-4d48-9f54-9479591aa9d2", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `true` if you want to use a template slug instead of a template ID when exporting products that have custom data.", "type": "text/plain" }, "key": "useTemplateSlugs", "value": "false" }, { "disabled": false, "description": { "content": "\nMany Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.\n\nFor more information about the attributes and operators that this endpoint supports, see [Export Products](/docs/api/pxm/products/export-products).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-export\",\n \"attributes\": {\n \"columns\": {\n \"include\": [\n \"description\",\n \"template:a1b2c3d4-e5f6-7890-1234-567890abcdef:isbn\"\n ]\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d005f6a-19d9-4288-a928-8637613c192f", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `true` if you want to use a template slug instead of a template ID when exporting products that have custom data.", "type": "text/plain" }, "key": "useTemplateSlugs", "value": "false" }, { "disabled": false, "description": { "content": "\nMany Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.\n\nFor more information about the attributes and operators that this endpoint supports, see [Export Products](/docs/api/pxm/products/export-products).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-export\",\n \"attributes\": {\n \"columns\": {\n \"include\": [\n \"description\",\n \"template:a1b2c3d4-e5f6-7890-1234-567890abcdef:isbn\"\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Hierarchies", "description": "```mdx-code-block\nimport HierarchyOverview from '/docs/partials/pxm/hierarchies/hierarchies.mdx';\nimport HierarchyCatalog from '/docs/partials/pxm/hierarchies/hierarchycatalogs.mdx';\n\n\n\n## Creating Hierarchies and Nodes\n\nYou can create the **Major Appliances** hierarchy by performing the following steps.\n\n1. Using [**Create a Hierarchy**](/docs/api/pxm/products/create-hierarchy), create a hierarchy whose name is **Major Appliances**. Each hierarchy has a hierarchy ID. In other words, the hierarchy ID is the ID of the root node.\n1. Using [**Create a Node in a hierarchy**](/docs/api/pxm/products/create-node), create the following child nodes. When you create a node in a hierarchy, by default, the node is a child of the root node. Specify `sort_order` to configure the order of the nodes.\n - **Ranges**\n - **Refrigerators**\n - **Dishwashers**\n1. Using [**Create a Node in a hierarchy**](/docs/api/pxm/products/create-node), create the **Electric Ranges** node, specifying **Ranges** as the parent node.\n1. Using [**Create a Node in a hierarchy**](/docs/api/pxm/products/create-node), create the following nodes, specifying **Electric Ranges** as the parent node.\n - **Electric Ranges 24ˮ**\n - **Electric Ranges 30ˮ**\n - **Double Oven**\n1. Using [**Create a Node in a hierarchy**](/docs/api/pxm/products/create-node), create the **Gas Ranges** node, specifying **Ranges** as the parent node.\n1. Using [**Create a Node in a hierarchy**](/docs/api/pxm/products/create-node), create the following nodes, specifying **Gas Ranges** as the parent node.\n - **Gas Ranges 24ˮ**\n - **Gas Ranges 30ˮ**\n - **Gas Ranges 32\"**\n - **Double Oven**\n1. Using [**Create a Node in a hierarchy**](/docs/api/pxm/products/create-node), create the following nodes, specifying **Dishwashers** as the parent node.\n - **Built-in**\n - **Standalone**\n\n## Hierarchies and Catalogs\n\n\n\n```\n", "item": [ { "id": "1c636ec9-eb07-450e-afec-f3f9b1a19124", "name": "Create a hierarchy", "request": { "name": "Create a hierarchy", "description": { "content": "```mdx-code-block\nimport CASummary from '/docs/partials/pxm/custom-attributes/custom-attribute-spec-summary.mdx';\n\nCreates a hierarchy with a name, description, and slug to organize products in your catalog.\n\n\n```\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"hierarchy\",\n \"attributes\": {\n \"name\": \"Shoes\",\n \"description\": \"Shoes Category\",\n \"slug\": \"shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures\",\n \"description\": \"Catégorie de chaussures\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "53c85ae5-4d2f-4907-b059-72cc7718f5d4", "name": "Returns a created hierarchy with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"hierarchy\",\n \"attributes\": {\n \"name\": \"Shoes\",\n \"description\": \"Shoes Category\",\n \"slug\": \"shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures\",\n \"description\": \"Catégorie de chaussures\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"hierarchy\",\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"attributes\": {\n \"description\": \"Shoes Category\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures\",\n \"description\": \"Catégorie de chaussures\"\n }\n },\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"name\": \"Shoes\",\n \"slug\": \"shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/children\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"owner\": \"store\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d69d5c49-bea9-4fc7-967b-33fbab38b8d8", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"hierarchy\",\n \"attributes\": {\n \"name\": \"Shoes\",\n \"description\": \"Shoes Category\",\n \"slug\": \"shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures\",\n \"description\": \"Catégorie de chaussures\"\n }\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cba44204-04d1-4b60-819b-63452e51bd52", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"hierarchy\",\n \"attributes\": {\n \"name\": \"Shoes\",\n \"description\": \"Shoes Category\",\n \"slug\": \"shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures\",\n \"description\": \"Catégorie de chaussures\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e3297be-a106-4254-9029-4ddd4a280a7f", "name": "Get all hierarchies", "request": { "name": "Get all hierarchies", "description": { "content": "Get all hierarchies\n\n#### Pagination\n\nThis endpoint supports offset-based pagination using `page[offset]` and `page[limit]` query parameters.\n\n:::caution Planned pagination changes — on or after 1 September 2026\n\nThe pagination links returned by this endpoint currently differ from the Elastic Path Commerce Cloud platform standard. Specifically, the `current` link is not returned, `first`/`last` are not always present, `prev` is incorrectly omitted on the second page, and `next` is incorrectly omitted on the second-to-last page.\n\nOn or after **1 September 2026**, this endpoint will be updated so that `current` and `first` are always present, `last` is present on every page except the final page, `next` is present on every page except the last, and `prev` is present on every page except the first. See the [links](#links) schema for full details.\n\nIf your integration iterates through pages using these links, please verify that it will handle the updated behaviour correctly before this date.\n\n:::\n\n#### Filtering\n \nMany Commerce API endpoints support filtering. The general syntax is described in [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description | Example |\n|----------------|------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|------------------------------------------|\n| `eq` | `id`, `hierarchy_id`, `owner`, `parent_id`, `name`, `slug`, `description`, `has_children`, `created_at`, `updated_at`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.id`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Equals. Checks if the value of the attribute matches the specified value. | `filter=eq(name,some-name)`, `filter=eq(locales.fr-FR.name,Nom-du-produit)` |\n| `in` | `id`, `hierarchy_id`, `parent_id`, `breadcrumbs.id` | Checks if the value of the attribute is included in the specified list. | `filter=in(id,1,2,3,4)` |\n| `lt`, `le`, `gt`, `ge` | `id`, `hierarchy_id`, `parent_id`, `created_at`, `updated_at` | Comparison operators. `lt`: Less than, `le`: Less than or equal to, `gt`: Greater than, `ge`: Greater than or equal to. | `filter=lt(id,100)`, `filter=ge(created_at,2022-01-01)` |\n| `like` | `name`, `slug`, `description`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Like. Checks if the attribute contains the specified string (wildcards supported). | `filter=like(name,*some-name*)`, `filter=like(locales.es-ES.description,*descripción*)` |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dc3398f2-e79f-4e7e-8234-42079cdac8f2", "name": "Returns a list of all hierarchies.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" } ], "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 \"type\": \"hierarchy\",\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"attributes\": {\n \"description\": \"Shoes Category\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures\",\n \"description\": \"Catégorie de chaussures\"\n }\n },\n \"name\": \"Shoes\",\n \"slug\": \"shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/children\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"owner\": \"store\",\n \"updated_at\": \"2024-01-10T20:30:50.867Z\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n }\n ]\n }\n }\n ],\n \"links\": {\n \"last\": \"/pcm/hierarchies?page[offset]=29&page[limit]=1\",\n \"next\": \"/pcm/hierarchies?page[offset]=1&page[limit]=1\"\n },\n \"meta\": {\n \"results\": {\n \"total\": 30\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "208189fd-de3e-4798-aafd-37f5b2d9f2ae", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a8a7012-54dc-4501-9b62-9d85c7d187d0", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6a55363-5569-46db-8e4c-4bb0c5f3de23", "name": "List all nodes", "request": { "name": "List all nodes", "description": { "content": "A fully paginated view of all nodes in all hierarchies regardless of depth.\n\n#### Filtering\n\nMany Commerce API endpoints support filtering. The general syntax is described in [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description | Example |\n|----------------|------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|------------------------------------------|\n| `eq` | `id`, `hierarchy_id`, `owner`, `parent_id`, `name`, `slug`, `description`, `has_children`, `created_at`, `updated_at`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.id`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Equals. Checks if the value of the attribute matches the specified value. | `filter=eq(name,some-name)`, `filter=eq(locales.fr-FR.name,Nom-du-produit)` |\n| `in` | `id`, `hierarchy_id`, `parent_id`, `breadcrumbs.id` | Checks if the value of the attribute is included in the specified list. | `filter=in(id,1,2,3,4)` |\n| `lt`, `le`, `gt`, `ge` | `id`, `hierarchy_id`, `parent_id`, `created_at`, `updated_at` | Comparison operators. `lt`: Less than, `le`: Less than or equal to, `gt`: Greater than, `ge`: Greater than or equal to. | `filter=lt(id,100)`, `filter=ge(created_at,2022-01-01)` |\n| `like` | `name`, `slug`, `description`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Like. Checks if the attribute contains the specified string (wildcards supported). | `filter=like(name,*some-name*)`, `filter=like(locales.es-ES.description,*descripción*)` |\n| `ilike` | `name`, `slug`, `description`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Case-insensitive like. Same as `like` but ignores case when matching. | `filter=ilike(name,*some-name*)` |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "When true, includes hierarchy objects in the response alongside nodes", "type": "text/plain" }, "key": "include_hierarchies", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "49779cc1-ddec-42c1-949d-d1c81e08f0ca", "name": "Returns a list of nodes", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "When true, includes hierarchy objects in the response alongside nodes", "type": "text/plain" }, "key": "include_hierarchies", "value": "false" } ], "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\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"type\": \"node\",\n \"attributes\": {\n \"description\": \"Latest Ballet Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n },\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:19:50.087Z\",\n \"owner\": \"store\",\n \"sort_order\": 5,\n \"updated_at\": \"2024-01-11T19:56:53.695Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 1 in French\"\n }\n }\n }\n ]\n }\n },\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\",\n \"attributes\": {\n \"description\": \"All Dress Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures habillées\",\n \"description\": \"Toutes les chaussures habillées\"\n }\n },\n \"name\": \"Dress Shoes\",\n \"slug\": \"dress-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/b2f5e53e-de3c-4548-98da-120f8b185d34/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/b2f5e53e-de3c-4548-98da-120f8b185d34/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:50:21.729Z\",\n \"owner\": \"store\",\n \"sort_order\": 3,\n \"updated_at\": \"2024-01-11T19:50:21.729Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\",\n \"name\": \"Dress Shoes\",\n \"slug\": \"dress-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 2 in French\"\n }\n }\n }\n ]\n }\n },\n {\n \"type\": \"hierarchy\",\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"attributes\": {\n \"description\": \"Shoes Category\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures\",\n \"description\": \"Catégorie de chaussures\"\n }\n },\n \"name\": \"Shoes\",\n \"slug\": \"shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/children\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"owner\": \"store\",\n \"updated_at\": \"2024-01-10T20:30:50.867Z\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n }\n ]\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 3\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48be7d59-3046-4150-bf79-fb246729b96d", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "When true, includes hierarchy objects in the response alongside nodes", "type": "text/plain" }, "key": "include_hierarchies", "value": "false" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fef11ef0-1f1b-4a34-b3d2-12953d01a1f4", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "When true, includes hierarchy objects in the response alongside nodes", "type": "text/plain" }, "key": "include_hierarchies", "value": "false" } ], "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": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cc693ab-d40a-4b07-822e-e797a14b2298", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "When true, includes hierarchy objects in the response alongside nodes", "type": "text/plain" }, "key": "include_hierarchies", "value": "false" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fad2354e-9322-46a8-b25c-d4d4a82b58a3", "name": "Get a hierarchy", "request": { "name": "Get a hierarchy", "description": { "content": "Retrieves the specified hierarchy.", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cc72177a-f85c-4a08-9d87-fdbe8dcdc626", "name": "Returns a hierarchy with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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 \"type\": \"hierarchy\",\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"attributes\": {\n \"description\": \"Shoes Category\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures\",\n \"description\": \"Catégorie de chaussures\"\n }\n },\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"name\": \"Shoes\",\n \"slug\": \"shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/children\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"owner\": \"store\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbf8cb82-db5a-4fa0-b05e-9a280ba75d6c", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "828a37c0-265f-4249-845d-36007e3390a4", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91ff6eaf-7206-4526-aa06-6f13faa483cd", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b3a31da-421a-4d17-b3e2-5a6332eac0a2", "name": "Update a hierarchy", "request": { "name": "Update a hierarchy", "description": { "content": "```mdx-code-block\nimport CASummary from '/docs/partials/pxm/custom-attributes/custom-attribute-spec-summary.mdx';\n\nUpdates a hierarchy. You can do a partial update, where you specify only the field value to change.\n\n\n```\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"hierarchy\",\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"attributes\": {\n \"description\": \"Shoes Category Updated\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": null\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": null,\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures mises à jour\",\n \"description\": \"Catégorie de chaussures mise à jour\"\n }\n },\n \"name\": \"Shoes Updated\",\n \"slug\": \"shoes\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3f3067a5-9c80-441f-b294-7e267db520a3", "name": "Successfully returns the updated hierarchy", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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 \"data\": {\n \"type\": \"hierarchy\",\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"attributes\": {\n \"description\": \"Shoes Category Updated\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": null\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": null,\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures mises à jour\",\n \"description\": \"Catégorie de chaussures mise à jour\"\n }\n },\n \"name\": \"Shoes Updated\",\n \"slug\": \"shoes\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"hierarchy\",\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"attributes\": {\n \"description\": \"Shoes Category Updated\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures mises à jour\",\n \"description\": \"Catégorie de chaussures mise à jour\"\n }\n },\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\"\n },\n \"shopper_attributes\": {\n \"charge_type\": \"credit card\"\n },\n \"name\": \"Shoes Updated\",\n \"slug\": \"shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/children\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"owner\": \"store\",\n \"updated_at\": \"2024-01-10T20:30:50.867Z\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes Updated\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a79ad575-0bd0-4823-8410-9ad0143cfffe", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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 \"data\": {\n \"type\": \"hierarchy\",\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"attributes\": {\n \"description\": \"Shoes Category Updated\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": null\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": null,\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures mises à jour\",\n \"description\": \"Catégorie de chaussures mise à jour\"\n }\n },\n \"name\": \"Shoes Updated\",\n \"slug\": \"shoes\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6efb2a58-38c8-43df-9287-18e74eb98c0a", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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 \"data\": {\n \"type\": \"hierarchy\",\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"attributes\": {\n \"description\": \"Shoes Category Updated\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": null\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": null,\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures mises à jour\",\n \"description\": \"Catégorie de chaussures mise à jour\"\n }\n },\n \"name\": \"Shoes Updated\",\n \"slug\": \"shoes\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a7d3277-9edb-4382-83b7-2ddc73ef0016", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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 \"data\": {\n \"type\": \"hierarchy\",\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"attributes\": {\n \"description\": \"Shoes Category Updated\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": null\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": null,\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures mises à jour\",\n \"description\": \"Catégorie de chaussures mise à jour\"\n }\n },\n \"name\": \"Shoes Updated\",\n \"slug\": \"shoes\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b257fd6-a32b-4e77-9d8c-71f2518ef0cd", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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 \"data\": {\n \"type\": \"hierarchy\",\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"attributes\": {\n \"description\": \"Shoes Category Updated\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": null\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": null,\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures mises à jour\",\n \"description\": \"Catégorie de chaussures mise à jour\"\n }\n },\n \"name\": \"Shoes Updated\",\n \"slug\": \"shoes\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1301bb80-d450-490b-a296-168bb41b0939", "name": "Delete a hierarchy", "request": { "name": "Delete a hierarchy", "description": { "content": "Deletes the specified hierarchy and all its children.", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "37d3e71c-3fca-4829-aeb8-3e79928aedf6", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "39e9fd86-aba8-425d-8299-7d0f256144de", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edb3c618-959c-4c9e-a1a4-6f2254f4e58a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "436b16ce-cbde-431a-b832-917463b01aa5", "name": "Create a node", "request": { "name": "Create a node", "description": { "content": "```mdx-code-block\nimport CASummary from '/docs/partials/pxm/custom-attributes/custom-attribute-spec-summary.mdx';\n\nCreates a node in the specified hierarchy.\n\n \n```\n\n ### Sorting Nodes in a Hierarchy\n \n You can sort the order of your nodes, regardless of where the nodes are in the hierarchy.\n\n You can do this by adding a `meta` object to the body of your request and specifying a `sort_order` value.\n \n The node with the highest value of `sort_order` is displayed first. For example, a node with a `sort_order` value of `3` appears before a node with a `sort_order` value of `2`.\n\n - If you don’t provide `sort_order` when creating nodes, all child nodes in the response for Get a Node’s Children request are ordered by the `updated_at` time in descending order, with the most recently updated child node first.\n - If you set `sort_order` for only a few child nodes, the child nodes with a `sort_order` value appear first and then other child nodes appear in the order of `updated_at` time.\n\n You can also specify a `sort_order` when creating a node relationship.\n\n - If you create a node (**Node A**) with a `sort_order` and then you create a relationship for **Node A** with another node (**Node B**), the `sort_order` you specified when creating **Node A** is overwritten.\n - If you create **Node A** and then you create a relationship with **Node B** but do not configure a `sort_order`, the `sort_order` you specified when you created **Node A** is not overwritten.\n \n ### Curating Products in a Node\n \n You can curate the products in a node. Product curation allows you to promote specific products within each node of your hierarchies, enabling you to create unique product collections in your storefront. For example, you may find you have an abundance of cotton T-Shirts and you want to promote these products to the top of the product list. When a shopper navigates to T-shirts, the cotton T-Shirts are displayed first.\n \n You can do this by adding a `curated_products` attribute to the body of your request and adding an array of product IDs to the attribute. You should add the products IDs in the order you want them to be displayed in your node. The first product ID is displayed first in the product list.\n \n You can only curate 20 products or less. You cannot have more than 20 curated products.\n \n - The product IDs you provide must exist in the specified node.\n - If a curated product is removed from a node, the product is also removed from the curated_products list.\n - Once you have curated the products in a node, you can use the get node products endpoint to retrieve a list of curated products.\n \n You can then display your curated products in your catalogs using the following catalog endpoints.\n \n - Get a node in your latest catalog release.\n - Get a node in a catalog.\n - Get all nodes in your latest catalog release.\n - Get all nodes in a catalog.\n - Get node children in your latest catalog release.\n - Get node children in a catalog.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"node\",\n \"attributes\": {\n \"name\": \"Ballet Shoes\",\n \"description\": \"All Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Toutes les ballerines\"\n }\n }\n },\n \"meta\": {\n \"sort_order\": 2\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c97525f9-df4c-4b3c-8ce4-ca70c7b3d70a", "name": "Successfully returns the created node", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"node\",\n \"attributes\": {\n \"name\": \"Ballet Shoes\",\n \"description\": \"All Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Toutes les ballerines\"\n }\n }\n },\n \"meta\": {\n \"sort_order\": 2\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"node\",\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"attributes\": {\n \"description\": \"All Ballet Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Toutes les chaussures de ballet\"\n }\n },\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/children\"\n }\n },\n \"parent\": {\n \"data\": {\n \"type\": \"node\",\n \"id\": \"14e8e15a-7214-435d-bccb-6ae9b570d683\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:19:50.087Z\",\n \"owner\": \"store\",\n \"parent_name\": \"Shoes\",\n \"sort_order\": 2,\n \"updated_at\": \"2024-01-11T19:19:50.087Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 1 in French\"\n }\n }\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39c7fc68-3721-4939-932b-6b69a2b0eee9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"node\",\n \"attributes\": {\n \"name\": \"Ballet Shoes\",\n \"description\": \"All Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Toutes les ballerines\"\n }\n }\n },\n \"meta\": {\n \"sort_order\": 2\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "323ef64a-d5c7-439b-bd49-6c7f98bead64", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"node\",\n \"attributes\": {\n \"name\": \"Ballet Shoes\",\n \"description\": \"All Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Toutes les ballerines\"\n }\n }\n },\n \"meta\": {\n \"sort_order\": 2\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4be111b-69d5-41cd-8551-8dbb978854be", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"node\",\n \"attributes\": {\n \"name\": \"Ballet Shoes\",\n \"description\": \"All Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Toutes les ballerines\"\n }\n }\n },\n \"meta\": {\n \"sort_order\": 2\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2d54fec-37f2-4b6c-b93d-18870195b59d", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"node\",\n \"attributes\": {\n \"name\": \"Ballet Shoes\",\n \"description\": \"All Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Toutes les ballerines\"\n }\n }\n },\n \"meta\": {\n \"sort_order\": 2\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26f247d2-eca4-4df7-82f4-e4fb24daefc1", "name": "Get all nodes in a hierarchy", "request": { "name": "Get all nodes in a hierarchy", "description": { "content": "A fully paginated view of all nodes in a hierarchy regardless of depth.\n\n#### Filtering\n\nMany Commerce API endpoints support filtering. The general syntax is described in [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description | Example |\n|----------------|------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|------------------------------------------|\n| `eq` | `id`, `hierarchy_id`, `owner`, `parent_id`, `name`, `slug`, `description`, `has_children`, `created_at`, `updated_at`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.id`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Equals. Checks if the value of the attribute matches the specified value. | `filter=eq(name,some-name)`, `filter=eq(locales.fr-FR.name,Nom-du-produit)` |\n| `in` | `id`, `hierarchy_id`, `parent_id`, `breadcrumbs.id` | Checks if the value of the attribute is included in the specified list. | `filter=in(id,1,2,3,4)` |\n| `lt`, `le`, `gt`, `ge` | `id`, `hierarchy_id`, `parent_id`, `created_at`, `updated_at` | Comparison operators. `lt`: Less than, `le`: Less than or equal to, `gt`: Greater than, `ge`: Greater than or equal to. | `filter=lt(id,100)`, `filter=ge(created_at,2022-01-01)` |\n| `like` | `name`, `slug`, `description`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Like. Checks if the attribute contains the specified string (wildcards supported). | `filter=like(name,*some-name*)`, `filter=like(locales.es-ES.description,*descripción*)` |\n| `ilike` | `name`, `slug`, `description`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Case-insensitive like. Same as `like` but ignores case when matching. | `filter=ilike(name,*some-name*)` |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a2612564-ac98-4c40-85ae-55f6a6824e16", "name": "Successfully returns the node's children", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"type\": \"node\",\n \"attributes\": {\n \"description\": \"Latest Ballet Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n },\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:19:50.087Z\",\n \"owner\": \"store\",\n \"sort_order\": 5,\n \"updated_at\": \"2024-01-11T19:56:53.695Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 1 in French\"\n }\n }\n }\n ]\n }\n },\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\",\n \"attributes\": {\n \"description\": \"All Dress Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures habillées\",\n \"description\": \"Toutes les chaussures habillées\"\n }\n },\n \"name\": \"Dress Shoes\",\n \"slug\": \"dress-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/b2f5e53e-de3c-4548-98da-120f8b185d34/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/b2f5e53e-de3c-4548-98da-120f8b185d34/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:50:21.729Z\",\n \"owner\": \"store\",\n \"sort_order\": 3,\n \"updated_at\": \"2024-01-11T19:50:21.729Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\",\n \"name\": \"Dress Shoes\",\n \"slug\": \"dress-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 2 in French\"\n }\n }\n }\n ]\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9159168e-45a4-4da7-9f2c-6f2f9573f475", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "affb6dc7-e365-4036-b3bb-5aa0643f5f64", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6efeff3-e8e5-4228-8e0c-e05c0932e23d", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89d44c96-e29b-41f3-b0af-c64b64a17dec", "name": "Get a node", "request": { "name": "Get a node", "description": { "content": "Retrieves a node from a hierarchy.", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID", "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6a4e85e7-5d79-449e-a18a-0a6b7f84e4ba", "name": "Returns a node with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"type\": \"node\",\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"attributes\": {\n \"description\": \"All Ballet Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Toutes les chaussures de ballet\"\n }\n },\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/children\"\n }\n },\n \"parent\": {\n \"data\": {\n \"type\": \"node\",\n \"id\": \"14e8e15a-7214-435d-bccb-6ae9b570d683\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:19:50.087Z\",\n \"owner\": \"store\",\n \"parent_name\": \"Shoes\",\n \"sort_order\": 2,\n \"updated_at\": \"2024-01-11T19:19:50.087Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 1 in French\"\n }\n }\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e23ff6ab-5e45-4979-8fe6-124867cb9934", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b54dc4bc-57af-4bac-ac72-466a031687cf", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb3615fe-d5b6-4e07-a847-380145374927", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6503d630-dacf-426e-8fec-9ba6187f4fc7", "name": "Update a node", "request": { "name": "Update a node", "description": { "content": "```mdx-code-block\nimport CASummary from '/docs/partials/pxm/custom-attributes/custom-attribute-spec-summary.mdx';\n\nUpdates the specified node in a hierarchy. You can do a partial update, where you specify only the field value to change.\n\n \n```\n\n### Sorting Nodes in a Hierarchy\n\nYou can sort the order of your nodes, regardless of where the nodes are in the hierarchy.\n \n The node with the highest value of sort_order is displayed first. For example, a node with a `sort_order` value of `3` appears before a node with a `sort_order` value of `2`.\n \n - If you don’t provide `sort_order` when creating nodes, all child nodes in the response for Get a Node’s Children request are ordered by the `updated_at` time in descending order, with the most recently updated child node first.\n - If you set `sort_order` for only a few child nodes or not all, the child nodes with a `sort_order` value appear first and then other child nodes appear in the order of `updated_at` time.\n \n You can also specify a sort_order when creating a node relationship.\n\n - If you update a node (**Node A**) with a `sort_order` and then you create a relationship for **Node A** with another node (**Node B**), the `sort_order` you specified when updating **Node A** is overwritten.\n - If you have updated **Node A** and then you create a relationship with **Node B** but do not configure a `sort_order`, the `sort_order` you specified when you updated **Node A** is not overwritten.\n \n ### Curating Products in a Node\n\n You can curate the products in a node. Product curation allows you to promote specific products within each node of your hierarchies, enabling you to create unique product collections in your storefront. For example, you may find you have an abundance of cotton T-Shirts and you want to promote these products to the top of the product list. When a shopper navigates to T-shirts, the cotton T-Shirts are displayed first.\n\n You can do this by adding a `curated_products` attribute to the body of your request and adding an array of product IDs to the attribute. You should add the products IDs in the order you want them to be displayed in your node. The first product ID is displayed first in the product list.\n\n You can only curate 20 products or less. You cannot have more than 20 curated products.\n \n - The product IDs you provide must exist in the specified node.\n - If a curated product is removed from a node, the product is also removed from the curated_products list.\n - Once you have curated the products in a node, you can use the get node products endpoint to retrieve a list of curated products.\n \n You can then display your curated products in your catalogs using the following catalog endpoints.\n \n - [Get a node in your latest catalog release](/docs/api/pxm/catalog/get-node)\n - [Get a node in a catalog](/docs/api/pxm/catalog/get-by-context-node)\n - [Get all nodes in your latest catalog release](/docs/api/pxm/catalog/get-all-nodes)\n - [Get all nodes in a catalog](/docs/api/pxm/catalog/get-by-context-all-nodes)\n - [Get node children in your latest catalog release](/docs/api/pxm/catalog/get-child-nodes)\n - [Get node children in a catalog](/docs/api/pxm/catalog/get-by-context-child-nodes)\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID", "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"node\",\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"attributes\": {\n \"name\": \"Ballet Shoes\",\n \"description\": \"Latest Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": null\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": null,\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n }\n },\n \"meta\": {\n \"sort_order\": 5\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1f644dca-1765-415b-aa2a-8bf1d504fd0b", "name": "Successfully returns the updated node", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"data\": {\n \"type\": \"node\",\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"attributes\": {\n \"name\": \"Ballet Shoes\",\n \"description\": \"Latest Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": null\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": null,\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n }\n },\n \"meta\": {\n \"sort_order\": 5\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"node\",\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"attributes\": {\n \"description\": \"Latest Ballet Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n },\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\"\n },\n \"shopper_attributes\": {\n \"charge_type\": \"credit card\"\n },\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:19:50.087Z\",\n \"owner\": \"store\",\n \"sort_order\": 5,\n \"updated_at\": \"2024-01-11T19:56:53.695Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 1 in French\"\n }\n }\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7924a32a-09a2-4d31-a285-ec78fba31d6b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"data\": {\n \"type\": \"node\",\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"attributes\": {\n \"name\": \"Ballet Shoes\",\n \"description\": \"Latest Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": null\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": null,\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n }\n },\n \"meta\": {\n \"sort_order\": 5\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e34ed1c-9a63-4c75-a715-82aa52fa8876", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"data\": {\n \"type\": \"node\",\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"attributes\": {\n \"name\": \"Ballet Shoes\",\n \"description\": \"Latest Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": null\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": null,\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n }\n },\n \"meta\": {\n \"sort_order\": 5\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4329a854-1e74-4606-aeec-780ad7131205", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"data\": {\n \"type\": \"node\",\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"attributes\": {\n \"name\": \"Ballet Shoes\",\n \"description\": \"Latest Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": null\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": null,\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n }\n },\n \"meta\": {\n \"sort_order\": 5\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbba14ce-4f04-4c14-8c03-32927d39c180", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"data\": {\n \"type\": \"node\",\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"attributes\": {\n \"name\": \"Ballet Shoes\",\n \"description\": \"Latest Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": null\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": null,\n \"charge_type\": \"credit card\"\n },\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n }\n },\n \"meta\": {\n \"sort_order\": 5\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6748572b-3733-48cf-b60d-81bef48b871c", "name": "Deletes a node", "request": { "name": "Deletes a node", "description": { "content": "Deletes a node by the node ID", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID", "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "df4bf582-5223-4da0-8c17-eae3c3602166", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "709fe89a-a905-42c1-95b3-b8e004774b92", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03448463-60be-4999-9c65-35296b4748a1", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83ca5a8f-8d11-41de-968b-335c5ecf1a81", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "055602b0-f1ef-4233-a8cf-43de8018dfae", "name": "Get a hierarchy's children", "request": { "name": "Get a hierarchy's children", "description": { "content": "Get a hierarchy's children\n\n#### Filtering\n\nMany Commerce API endpoints support filtering. The general syntax is described in [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description | Example |\n|----------------|------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|------------------------------------------|\n| `eq` | `id`, `hierarchy_id`, `owner`, `parent_id`, `name`, `slug`, `description`, `has_children`, `created_at`, `updated_at`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.id`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Equals. Checks if the value of the attribute matches the specified value. | `filter=eq(name,some-name)`, `filter=eq(locales.fr-FR.name,Nom-du-produit)` |\n| `in` | `id`, `hierarchy_id`, `parent_id`, `breadcrumbs.id` | Checks if the value of the attribute is included in the specified list. | `filter=in(id,1,2,3,4)` |\n| `lt`, `le`, `gt`, `ge` | `id`, `hierarchy_id`, `parent_id`, `created_at`, `updated_at` | Comparison operators. `lt`: Less than, `le`: Less than or equal to, `gt`: Greater than, `ge`: Greater than or equal to. | `filter=lt(id,100)`, `filter=ge(created_at,2022-01-01)` |\n| `like` | `name`, `slug`, `description`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Like. Checks if the attribute contains the specified string (wildcards supported). | `filter=like(name,*some-name*)`, `filter=like(locales.es-ES.description,*descripción*)` |\n| `ilike` | `name`, `slug`, `description`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Case-insensitive like. Same as `like` but ignores case when matching. | `filter=ilike(name,*some-name*)` |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a29e2229-74c6-4ade-8c1d-7f6076fe2bca", "name": "Returns the hierarchy's children.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"type\": \"node\",\n \"attributes\": {\n \"description\": \"Latest Ballet Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n },\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:19:50.087Z\",\n \"owner\": \"store\",\n \"sort_order\": 5,\n \"updated_at\": \"2024-01-11T19:56:53.695Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 1 in French\"\n }\n }\n }\n ]\n }\n },\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\",\n \"attributes\": {\n \"description\": \"All Dress Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures habillées\",\n \"description\": \"Toutes les chaussures habillées\"\n }\n },\n \"name\": \"Dress Shoes\",\n \"slug\": \"dress-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/b2f5e53e-de3c-4548-98da-120f8b185d34/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/b2f5e53e-de3c-4548-98da-120f8b185d34/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:50:21.729Z\",\n \"owner\": \"store\",\n \"sort_order\": 3,\n \"updated_at\": \"2024-01-11T19:50:21.729Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\",\n \"name\": \"Dress Shoes\",\n \"slug\": \"dress-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 2 in French\"\n }\n }\n }\n ]\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6790f46-6384-4201-927d-92960ac10917", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dbd02d2-b9b5-45f9-8502-e732098d36c0", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0a1955b-c76e-4c8f-a060-31b74b790972", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d9abb60-1e19-414d-bd84-447fe60c70bc", "name": "Create relationships between a hierarchy and child nodes", "request": { "name": "Create relationships between a hierarchy and child nodes", "description": { "content": "Use this endpoint to create relationships between a hierarchy and one or more child nodes. You can create a relationship only if:\n\n- All child nodes already exist.\n- Every child node in the request body must belong to this hierarchy.\n- All siblings in a hierarchy must have a unique `name` and `slug`. Siblings are the child nodes that are related to the same parent.\n\n### Sort Order\n\nYou can also provide `sort_order` information when you create a relationship by adding a `meta` object to the array of node reference objects for each child node that requires sorting.\n\nThe node with the highest value of `sort_order` appears at the top of the response. For example, a node with a `sort_order` value of `3` appears before a node with a `sort_order` value of `2`.\n\n- If you don’t provide `sort_order` when creating relationships, all child nodes in the response for Get a Hierarchy’s Children request are ordered by the `updated_at` time in descending order. The most recently updated child node appears at the top of the response.\n- If you set `sort_order` for only a few child nodes or not all, the child nodes with `sort_order` value appear first in the response and then other child nodes appear in the order of `updated_at` time.\n\nYou can also specify a `sort_order` when creating and updating a node.\n\n- If you create or update a node (**Node A**) with a `sort_order` and then you create a relationship for **Node A** with hierarchy (**Hierarchy A**) with a new `sort_order`, the `sort_order` you specified when creating\\updating **Node A** is overwritten.\n- If you create\\update **Node A** and then you create a relationship with **Hierarchy A** but do not configure a `sort_order`, the `sort_order` you specified when you created\\updated **Node A** is not overwritten.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7802defb-837c-44a0-86e8-7bd39dc31198", "name": "Successfully returns the hierarchy", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"hierarchy\",\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"attributes\": {\n \"description\": \"Shoes Category Updated\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures mises à jour\",\n \"description\": \"Catégorie de chaussures mise à jour\"\n }\n },\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\"\n },\n \"shopper_attributes\": {\n \"charge_type\": \"credit card\"\n },\n \"name\": \"Shoes Updated\",\n \"slug\": \"shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/children\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"owner\": \"store\",\n \"updated_at\": \"2024-01-10T20:30:50.867Z\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes Updated\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57b81bbe-3481-470d-b079-06084af418f9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7508eac7-e4f3-412a-9a72-bf5e42f596c5", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b932b576-8549-4802-9806-6b20c56e9080", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a065cd8-8bdb-40a7-a27c-ec89d651d80f", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f6b88b9-4eee-4a3c-aede-dfd3dbddd908", "name": "Create relationships between a node and child nodes", "request": { "name": "Create relationships between a node and child nodes", "description": { "content": "Use this endpoint to create relationships between a single parent node and one or more child nodes. You can create a relationship only if:\n\n- The parent node already exists.\n- All child nodes already exist.\n- Every child node in the body of the request exists in the same hierarchy as the parent node.\n- A node is not a parent of itself. An array of child nodes request body must not contain the ID of the parent node in the path.\n- All siblings in a hierarchy must have a unique `slug`. Siblings are the child nodes that are related to the same parent.\n\n### Sort Order\n\nYou can also provide `sort_order` information when you create a relationship by adding a `meta` object to the array of node reference objects for each child node that requires sorting.\n\nThe node with the highest value of `sort_order` appears at the top of the response. For example, a node with a `sort_order` value of `3` appears before a node with a `sort_order` value of `2`.\n\n- If you don’t provide `sort_order` when creating relationships, all child nodes in the response for Get a Node’s Children request are ordered by the `updated_at` time in descending order. The most recently updated child node appears at the top of the response.\n- If you set `sort_order` for only a few child nodes or not all, the child nodes with `sort_order` value appear first in the response and then other child nodes appear in the order of `updated_at` time.\n\nYou can also specify a `sort_order` when creating and updating a node.\n\n- If you create or update a node (**Node A**) with a `sort_order` and then you create a relationship for **Node A** with another node (**Node B**) with a new `sort_order`, the `sort_order` you specified when creating\\updating **Node A** is overwritten.\n- If you create\\update **Node A** and then you create a relationship with **Node B** but do not configure a `sort_order`, the `sort_order` you specified when you created\\updated **Node A** is not overwritten.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID", "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "86d5efdd-c644-4da0-8923-2da605419413", "name": "Successfully returns the parent node", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"node\",\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"attributes\": {\n \"description\": \"Latest Ballet Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n },\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\"\n },\n \"shopper_attributes\": {\n \"charge_type\": \"credit card\"\n },\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:19:50.087Z\",\n \"owner\": \"store\",\n \"sort_order\": 5,\n \"updated_at\": \"2024-01-11T19:56:53.695Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 1 in French\"\n }\n }\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c476976e-ef68-403b-b55c-cd46de9d57a4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b61259dd-d717-4a8b-8d18-e1552cc6ab53", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cde6d420-c91a-4c1e-aee7-3ba065009898", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa38245b-7800-4374-b2af-42def9c11e4a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7fc3f6b-5204-47e9-9bcf-7e96c521f87e", "name": "Get a node's children", "request": { "name": "Get a node's children", "description": { "content": "Retrieves the child nodes for a specified node.\n\n#### Filtering\n\nMany Commerce API endpoints support filtering. The general syntax is described in [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description | Example |\n|----------------|------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|------------------------------------------|\n| `eq` | `id`, `hierarchy_id`, `owner`, `parent_id`, `name`, `slug`, `description`, `has_children`, `created_at`, `updated_at`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.id`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Equals. Checks if the value of the attribute matches the specified value. | `filter=eq(name,some-name)`, `filter=eq(locales.fr-FR.name,Nom-du-produit)` |\n| `in` | `id`, `hierarchy_id`, `parent_id`, `breadcrumbs.id` | Checks if the value of the attribute is included in the specified list. | `filter=in(id,1,2,3,4)` |\n| `lt`, `le`, `gt`, `ge` | `id`, `hierarchy_id`, `parent_id`, `created_at`, `updated_at` | Comparison operators. `lt`: Less than, `le`: Less than or equal to, `gt`: Greater than, `ge`: Greater than or equal to. | `filter=lt(id,100)`, `filter=ge(created_at,2022-01-01)` |\n| `like` | `name`, `slug`, `description`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Like. Checks if the attribute contains the specified string (wildcards supported). | `filter=like(name,*some-name*)`, `filter=like(locales.es-ES.description,*descripción*)` |\n| `ilike` | `name`, `slug`, `description`, `locales.[locale].name`, `locales.[locale].description`, `breadcrumbs.name`, `breadcrumbs.slug`, `breadcrumbs.locales.[locale].name` | Case-insensitive like. Same as `like` but ignores case when matching. | `filter=ilike(name,*some-name*)` |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID", "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ffb81a2b-0a02-4d8a-a809-a3f79d7c4fd4", "name": "Successfully returns the node's children", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"type\": \"node\",\n \"attributes\": {\n \"description\": \"Latest Ballet Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n },\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:19:50.087Z\",\n \"owner\": \"store\",\n \"sort_order\": 5,\n \"updated_at\": \"2024-01-11T19:56:53.695Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 1 in French\"\n }\n }\n }\n ]\n }\n },\n {\n \"type\": \"node\",\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\",\n \"attributes\": {\n \"description\": \"All Dress Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussures habillées\",\n \"description\": \"Toutes les chaussures habillées\"\n }\n },\n \"name\": \"Dress Shoes\",\n \"slug\": \"dress-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/b2f5e53e-de3c-4548-98da-120f8b185d34/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/b2f5e53e-de3c-4548-98da-120f8b185d34/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:50:21.729Z\",\n \"owner\": \"store\",\n \"sort_order\": 3,\n \"updated_at\": \"2024-01-11T19:50:21.729Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"b2f5e53e-de3c-4548-98da-120f8b185d34\",\n \"name\": \"Dress Shoes\",\n \"slug\": \"dress-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 2 in French\"\n }\n }\n }\n ]\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29b969e1-773a-4a39-9897-37537a965ad1", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da76fa93-2edf-4b18-9e13-717efc16e558", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "993f4aa6-188f-46b9-8dc7-8adece60ce09", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(name,some-name)" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43acd4b0-4879-41df-ad6a-d904f69bcd73", "name": "Update a node's parent", "request": { "name": "Update a node's parent", "description": { "content": "Changes the parent of the specified node. The new parent node must be located within the same hierarchy as the specified node.\n\nYou cannot move a node to another hierarchy. If you want to put the specified node into another hierarchy, create the node in the target hierarchy and delete it from the current hierarchy.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "parent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID", "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"node\",\n \"id\": \"60dc3982-ab34-47e8-9173-c920c63dc382\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "be56f74a-d78d-406c-8409-9a663a8f0993", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "parent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "header": [ { "key": "Content-Type", "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 \"data\": {\n \"type\": \"node\",\n \"id\": \"60dc3982-ab34-47e8-9173-c920c63dc382\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9f9b59b-3a8c-40d2-a323-a60c57d15476", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "parent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"data\": {\n \"type\": \"node\",\n \"id\": \"60dc3982-ab34-47e8-9173-c920c63dc382\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e27ba17-68f8-4ed5-9ded-4e658f0071cb", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "parent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"data\": {\n \"type\": \"node\",\n \"id\": \"60dc3982-ab34-47e8-9173-c920c63dc382\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29738e81-204a-4c4b-a639-7a5fd8ced714", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "parent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"data\": {\n \"type\": \"node\",\n \"id\": \"60dc3982-ab34-47e8-9173-c920c63dc382\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1203237f-7186-402c-8818-dd828e412b03", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "parent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"data\": {\n \"type\": \"node\",\n \"id\": \"60dc3982-ab34-47e8-9173-c920c63dc382\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6cfc87a-6211-465b-817c-8d56b373efba", "name": "Delete a node's parent", "request": { "name": "Delete a node's parent", "description": {}, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "parent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID", "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "0fcddb7d-a8bb-4a28-8626-a12f4b70a10c", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "parent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "0c8e6e8e-bd71-4fe9-8362-640d608ecfa8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "parent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "866bace9-7550-404e-9424-69900b0f091a", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "parent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3703a008-0360-4a4b-969b-33e16e490db3", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "parent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c85be2c-9515-4c7f-bf40-4b05ae02db26", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "parent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "404e4507-a7c7-49c5-83c7-706ff9a66b7d", "name": "Create a node's product relationships", "request": { "name": "Create a node's product relationships", "description": { "content": "Creates relationships between the specified node and one or more products in a specified hierarchy.", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID", "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "cd9d9056-6d39-4ca6-83c9-1f0f8d768e20", "name": "Successfully returns the updated node", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"node\",\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"attributes\": {\n \"description\": \"Latest Ballet Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n },\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\"\n },\n \"shopper_attributes\": {\n \"charge_type\": \"credit card\"\n },\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:19:50.087Z\",\n \"owner\": \"store\",\n \"sort_order\": 5,\n \"updated_at\": \"2024-01-11T19:56:53.695Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 1 in French\"\n }\n }\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd9c1f13-5a22-4d9a-8a7a-a37f2545a74a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af3f0295-09a2-4999-b66b-d871f38805cc", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb82528f-21dc-44b5-b02a-8badbd255baa", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "683b66fb-904d-466e-81a1-d72a9436ad13", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "947151c3-f1dc-43ec-a2c7-deae43716e1e", "name": "Deletes a node's product relationships", "request": { "name": "Deletes a node's product relationships", "description": {}, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID", "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "984ac961-687a-4858-9fbc-cfcf60c9ce40", "name": "Successfully returns the updated node", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"node\",\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"attributes\": {\n \"description\": \"Latest Ballet Shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Chaussons de ballet\",\n \"description\": \"Dernières chaussures de ballet\"\n }\n },\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\"\n },\n \"shopper_attributes\": {\n \"charge_type\": \"credit card\"\n },\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\"\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/children\"\n }\n },\n \"products\": {\n \"data\": [],\n \"links\": {\n \"related\": \"/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/products\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2024-01-11T19:19:50.087Z\",\n \"owner\": \"store\",\n \"sort_order\": 5,\n \"updated_at\": \"2024-01-11T19:56:53.695Z\",\n \"hierarchy_id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"breadcrumbs\": [\n {\n \"id\": \"6183d10c-94b5-4caa-9f12-2f14cb738d41\",\n \"name\": \"Shoes\",\n \"slug\": \"shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"hierarchy 1 in French\"\n }\n }\n },\n {\n \"id\": \"9ea0de15-3347-43dd-8faa-cd32f44a04c7\",\n \"name\": \"Ballet Shoes\",\n \"slug\": \"ballet-shoes\",\n \"locales\": {\n \"fr-FR\": {\n \"name\": \"Node 1 in French\"\n }\n }\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16fc069e-396a-423c-8a5b-778292532e85", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15d796da-936e-4732-9649-3b69da64adc2", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0c9b739-fe77-41ff-98ad-010319199efe", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "relationships", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26e58ff5-639b-47d5-9cc7-44a88e330746", "name": "Get a node's products", "request": { "name": "Get a node's products", "description": { "content": "Returns the products associated with the specified hierarchy node from a published catalog. Products must be in a live status. If the products have been curated using the update a hierarchy node endpoint, then the products are returned in the order specified in the `curated_products` attribute in the body of the update a hierarchy node request. A product that is curated has the \"curated_product\": true attribute displayed.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } }, { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID", "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8c5f5a73-d55c-4daa-a5c7-c3547ac69ff5", "name": "Successfully returns the node's products", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\",\n \"attributes\": {\n \"commodity_type\": \"physical\",\n \"custom_inputs\": {\n \"back\": {\n \"name\": \"T-Shirt Back\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n },\n \"front\": {\n \"name\": \"T-Shirt Front\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n }\n },\n \"description\": \"T-shirt.\",\n \"mpn\": \"1234-5678-TTTT\",\n \"name\": \"T-Shirt\",\n \"sku\": \"97805\",\n \"slug\": \"97805\",\n \"status\": \"live\",\n \"upc_ean\": \"12345656\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"extensions\": {\n \"products(size)\": {\n \"widthMM\": 600,\n \"fuelType\": \"electric\",\n \"hasUKPlug\": true,\n \"online\": null\n }\n }\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/children\"\n }\n },\n \"component_products\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/component_products\"\n }\n },\n \"files\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/files\"\n }\n },\n \"main_image\": {\n \"data\": null\n },\n \"templates\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/templates\"\n }\n },\n \"variations\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/variations\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2022-08-18T14:25:57.391Z\",\n \"owner\": \"store\",\n \"product_types\": [\n \"standard\"\n ],\n \"updated_at\": \"2022-08-18T14:25:57.391Z\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 1\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e821ffe2-34a4-4d50-a1a2-8fe97d63000e", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e7acf66-4dec-4d5f-897f-cf055e862531", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84514001-8cc7-49ed-92b9-27dadeb18635", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "nodes", ":nodeID", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier for the node.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "nodeID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71bf6950-de86-40c0-a7b7-0530612dd7cc", "name": "Duplicate a hierarchy", "request": { "name": "Duplicate a hierarchy", "description": { "content": "Using this option, you can duplicate an existing hierarchy. This is useful because it enables you to quickly and easily create multiple hierarchies with the same node structure.\n\nWhen you duplicate a hierarchy, you can specify a new name and/or a new description and/or a new slug for the duplicated hierarchy. All other attributes will stay the same.\n\nAny nodes in the existing hierarchy are also replicated in the duplicated hierarchy. In addition, you can optionally use the `include_products` attribute to specify whether you want products associated with the nodes in an existing hierarchy to be associated with the nodes in the duplicated hierarchy. By default, product relationships in an existing hierarchy are not duplicated in a duplicate hierarchy.\n\nDuplicating a hierarchy is an asynchronous operation. When you duplicate a hierarchy, a job is created. The jobId of the job is displayed in the response. When the job is complete, the duplicate hierarchy operation is also complete. You can use the jobId to see the status of your job using Get a Job.\n\nJobs are processed one at a time. You can continue to send duplicate hierarchy requests, but those jobs are queued. In other words, Commerce looks for any jobs that have a status of PENDING and starts the job with the earliest created date. This process is repeated until all jobs are processed. \n\nOnce the job is complete, run:\n\n- Get all hierarchies to retrieve the HierarchyId of your duplicated hierarchy.\n- Get a hierarchy to retrieve the nodes and (if applicable) products associated with the duplicated hierarchy.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "duplicate_job" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID", "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"hierarchy\",\n \"attributes\": {\n \"name\": \"New Shoes\",\n \"description\": \"New Shoes Category\",\n \"include_products\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1d50cf2d-b7a9-414a-9c5c-c2e54bd3ba7e", "name": "Successfully returns the duplicate hierarchy job ID", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "duplicate_job" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"hierarchy\",\n \"attributes\": {\n \"name\": \"New Shoes\",\n \"description\": \"New Shoes Category\",\n \"include_products\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"pim-job\",\n \"id\": \"1d9b101e-a40a-4e53-9f54-08a9ede65019\",\n \"attributes\": {\n \"completed_at\": null,\n \"created_at\": \"2024-01-11T22:49:10.338Z\",\n \"started_at\": null,\n \"status\": \"pending\",\n \"type\": \"hierarchy-duplicate\",\n \"updated_at\": \"2024-01-11T22:49:10.338Z\"\n },\n \"meta\": {\n \"x_request_id\": \"40995a1d-c0c1-4d52-a178-bfb5399ab0ec\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "786d90f4-2d8f-4949-82b2-742d6ded7280", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "duplicate_job" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"hierarchy\",\n \"attributes\": {\n \"name\": \"New Shoes\",\n \"description\": \"New Shoes Category\",\n \"include_products\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "713606aa-d207-41a5-b2fb-2f94ace2c7f0", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "duplicate_job" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"hierarchy\",\n \"attributes\": {\n \"name\": \"New Shoes\",\n \"description\": \"New Shoes Category\",\n \"include_products\": true\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49ff4638-1097-42c1-ab83-99ef38afcf04", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "hierarchies", ":hierarchyID", "duplicate_job" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the hierarchy.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "hierarchyID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"hierarchy\",\n \"attributes\": {\n \"name\": \"New Shoes\",\n \"description\": \"New Shoes Category\",\n \"include_products\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Jobs", "description": "```mdx-code-block\nimport ProductJobs from '/docs/partials/pxm/jobs/jobs.mdx';\n\n\n```\n", "item": [ { "id": "eb3300c3-2a07-4bae-bacd-dcde1ecfebdc", "name": "Get All Jobs", "request": { "name": "Get All Jobs", "description": { "content": "The jobs endpoints displays the status of a number of endpoints that function as jobs, for example, product import and export, price book import, building child products, and duplicating hierarchies.", "type": "text/plain" }, "url": { "path": [ "pcm", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e589b8c5-bd2d-4c9a-b280-aef2c63159e7", "name": "Returns all the jobs.", "originalRequest": { "url": { "path": [ "pcm", "jobs" ], "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" } ], "body": "{\n \"data\": [\n {\n \"type\": \"pim-job\",\n \"id\": \"1ea62172-57f6-45e5-a708-ab5bd634e3f9\",\n \"attributes\": {\n \"completed_at\": \"2024-01-05T13:46:42.142Z\",\n \"created_at\": \"2024-01-05T13:46:41.695Z\",\n \"started_at\": \"2024-01-05T13:46:42.07Z\",\n \"status\": \"success\",\n \"type\": \"product-import\",\n \"updated_at\": \"2024-01-05T13:46:42.07Z\"\n },\n \"meta\": {\n \"x_request_id\": \"7e832a26-d615-4305-b26a-e33c9c2fc06a\"\n }\n },\n {\n \"type\": \"pim-job\",\n \"id\": \"3ab3deca-1f11-47b7-a409-24ea3234d72c\",\n \"attributes\": {\n \"completed_at\": null,\n \"created_at\": \"2024-01-05T15:27:23.161Z\",\n \"started_at\": \"2024-01-05T15:27:23.65Z\",\n \"updated_at\": \"2024-01-05T15:27:23.65Z\",\n \"status\": \"started\",\n \"type\": \"product-import\"\n },\n \"meta\": {\n \"x_request_id\": \"9ac00140-0037-4c6a-913c-b812196a2de6\"\n }\n },\n {\n \"type\": \"pim-job\",\n \"id\": \"7e1b9ba1-c844-4556-9b16-4ae3f0988b0f\",\n \"attributes\": {\n \"completed_at\": \"2024-01-05T15:27:23.663Z\",\n \"created_at\": \"2024-01-05T15:27:23.161Z\",\n \"started_at\": \"2024-01-05T15:27:23.65Z\",\n \"updated_at\": \"2024-01-05T15:27:23.65Z\",\n \"status\": \"success\",\n \"type\": \"product-export\"\n },\n \"meta\": {\n \"file_locations\": [],\n \"filter\": \"eq(sku,product-1)\",\n \"x_request_id\": \"fad8c5c0-9546-4e0c-b68e-8a2d809891e5\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 1\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ab1aa4e-1a32-45df-b124-5935f2a20b20", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "jobs" ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ae3cd3d-bbeb-4167-9216-54bb9076ef54", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "jobs" ], "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": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87eec8d2-6a9a-4e1c-984b-2f201a98760b", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "jobs" ], "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d18d083-2a36-492d-9f93-58d7c1d72802", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "jobs" ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e98ffe2-1b16-4e3e-87e7-acda219355dc", "name": "Get a Job", "request": { "name": "Get a Job", "description": {}, "url": { "path": [ "pcm", "jobs", ":jobID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID", "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1aeb18e7-5c3c-465e-bf95-1e22bbbbb495", "name": "Returns a job with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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 \"type\": \"pim-job\",\n \"id\": \"1ea62172-57f6-45e5-a708-ab5bd634e3f9\",\n \"attributes\": {\n \"started_at\": null,\n \"completed_at\": null,\n \"created_at\": \"2024-01-05T13:46:41.695Z\",\n \"status\": \"started\",\n \"type\": \"product-import\",\n \"updated_at\": \"2024-01-05T13:46:42.07Z\"\n },\n \"meta\": {\n \"x_request_id\": \"7e832a26-d615-4305-b26a-e33c9c2fc06a\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bcf1d4d-3546-4998-9905-2e3535767b6c", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13dbad33-97c0-49d7-bddc-df083ead286d", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0650dd85-fac0-43bc-9459-e60f61222e7b", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f90d558d-0c2e-4d0f-b222-e53a81208e48", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c15deef-160c-4263-be0d-87c97c8fb1cb", "name": "Cancel a Job", "request": { "name": "Cancel a Job", "description": { "content": "The jobs endpoints display the status of a number of endpoints that function as jobs, for example, product import and export, and duplicating hierarchies.\n\nJobs are processed one at a time. You can continue to send job requests, but those jobs are queued. In other words, Commerce looks for any jobs that have a status of PENDING and starts the job with the earliest created date. If you decide that a specific job needs to be prioritized over another, you can cancel the less critical job using the `Cancel a job` endpoint. You can only cancel jobs whose status is PENDING.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "jobs", ":jobID", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID", "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0629badf-82c0-45ca-868d-ba2c3be9373f", "name": "Successfully cancelled job", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"pim-job\",\n \"id\": \"1e5da4bf-b2c0-4619-bb3d-f749875b15bb\",\n \"attributes\": {\n \"started_at\": null,\n \"completed_at\": null,\n \"created_at\": \"2023-11-14T15:37:13.589Z\",\n \"status\": \"cancelled\",\n \"type\": \"product-import\",\n \"updated_at\": \"2023-11-14T15:37:13.589Z\"\n },\n \"meta\": {\n \"x_request_id\": \"4fde01c1-95ba-4dd6-948e-b9d5763ff9c2\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f39c0fba-6b7a-47a3-8ff9-976ed41ed417", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb6f67e3-56e1-46f0-ac95-385f9d023bbc", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92cb99e5-b7a1-4a14-9a02-917e76aa0271", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "238e8d2f-2d2e-4ddf-95fa-0076947080b1", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5ea1bd9-77af-48f0-973f-4d270e89718f", "name": "Get Job Errors", "request": { "name": "Get Job Errors", "description": {}, "url": { "path": [ "pcm", "jobs", ":jobID", "errors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID", "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7bbcbb10-ee4b-480f-92eb-46069204d538", "name": "Successful", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID", "errors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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 \"type\": \"pim-job-error\",\n \"id\": \"2950cae3-1050-4c43-9fbd-2aa60dc5c249\",\n \"attributes\": {\n \"message\": \"data.attributes.sku: Must be unique amongst products.\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 1\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aebf70ac-b07c-4f3e-8f1b-3dd08f213ed4", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID", "errors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf99ea6e-925b-433c-98e3-1ca0e768df28", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID", "errors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aea801f-a2da-45c1-b5b7-aad3db11ff1f", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID", "errors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b399a168-3af8-4756-82a3-909b5940a810", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "jobs", ":jobID", "errors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the job.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "jobID" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Product Relationships", "description": "", "item": [ { "id": "1eb20c6f-692d-4fc6-8414-fc487f249a34", "name": "Attach Custom Relationships to a Product", "request": { "name": "Attach Custom Relationships to a Product", "description": { "content": "You can attach up to 5 custom relationships to a product. \n\nOnce you have attached a custom relationship to a product, you can then create relationships from a product to one or many other products. See [Associate a product to one or more products using a custom relationship](/docs/api/pxm/products/product-association-id). \n\nSee [Custom Relationships](/guides/key-concepts/product-experience-manager/custom-relationships/).\n\n### Prerequisites\n - A Custom Relationship has been created, see [create a Custom Relationship](/docs/api/pxm/products/create-custom-relationship),\n - A Product has been created.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e37af5cb-7da0-40fc-a3c3-6f81fd10d097", "name": "Returns the attached custom relationships", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"f3297ee8-da90-45e9-ae56-a2654aebbdfe\",\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Kitchen electrics\",\n \"description\": \"Kitchen electric devices\",\n \"slug\": \"CRP_kitchen_individual_devices\",\n \"bi_directional\": false\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\"\n }\n }\n },\n {\n \"id\": \"21b1315b-c47f-4766-85bf-7bf0f94d73b6\",\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"bi_directional\": true\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\"\n }\n }\n },\n {\n \"id\": \"e390ff7e-efc4-4769-90d2-fceabcc1e2cd\",\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"sort_order\": 5,\n \"external_name\": \"Similar items to consider\",\n \"external_description\": \"Check out these similar products that may also meet your needs or match your preferences.\",\n \"bi_directional\": false\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\"\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"/pcm/custom_relationships?page[offset]=29&page[limit]=1\",\n \"next\": \"/pcm/custom_relationships?page[offset]=1&page[limit]=1\"\n },\n \"meta\": {\n \"results\": {\n \"total\": 3\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e276aa36-5284-4f7b-b6b3-36a16c5a08ed", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adb1a008-5c46-4501-b3a4-50bab7a5afe0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79cc17ec-9860-4112-998f-774bcb11a7b2", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9eca72f4-718c-4dc9-bd9d-e8b93749c319", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0a5469f-1d1d-410e-8493-943a2963e844", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f29a1b4b-0d95-404a-afdc-f796bb9d724f", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ad7c08c6-28bb-4fde-a240-516b58c3d24d", "name": "Delete Custom Relationships from a Product", "request": { "name": "Delete Custom Relationships from a Product", "description": { "content": "Delete Custom Relationships from a Product. Multiple Custom Relationships can be deleted from a product in one request.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6193ce3c-8ca2-4be0-9353-f73cd6e87102", "name": "Successfully deleted custom relationships.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "510fb428-9dde-48cc-8363-c9478a51d72f", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "340eb4ae-8c08-42f0-973d-6f84d48cc054", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bed66e85-4c95-4b2e-9893-4b7b7a49f9df", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "992e3217-2f6c-46f3-bf23-bf8cccb246d2", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a56d7941-a4cd-4025-83ea-8d4b07272249", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1ec0bae-1b6a-4f81-ab47-04c925b21625", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c260348-a7c4-4158-a938-1ddf970e8e52", "name": "Get all Custom Relationships attached to a Product", "request": { "name": "Get all Custom Relationships attached to a Product", "description": { "content": "### Prerequisites\n - Custom Relationships have been attached to a product, see [Attach Custom Relationships to a Product](/docs/api/pxm/products/attach-custom-relationships)\n - **OR** Products have been related to one another, see [Create a Relationship between a product with one or more products](/docs/api/pxm/products/product-association-id)\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a91c1c7c-5b58-4640-8517-0c1f87d630bd", "name": "Returns the attached custom relationship.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "GET", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\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\": \"f3297ee8-da90-45e9-ae56-a2654aebbdfe\",\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Kitchen electrics\",\n \"description\": \"Kitchen electric devices\",\n \"slug\": \"CRP_kitchen_individual_devices\",\n \"bi_directional\": false\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\"\n }\n }\n },\n {\n \"id\": \"21b1315b-c47f-4766-85bf-7bf0f94d73b6\",\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"bi_directional\": true\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\"\n }\n }\n },\n {\n \"id\": \"e390ff7e-efc4-4769-90d2-fceabcc1e2cd\",\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"sort_order\": 5,\n \"external_name\": \"Similar items to consider\",\n \"external_description\": \"Check out these similar products that may also meet your needs or match your preferences.\",\n \"bi_directional\": false\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\"\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"/pcm/custom_relationships?page[offset]=29&page[limit]=1\",\n \"next\": \"/pcm/custom_relationships?page[offset]=1&page[limit]=1\"\n },\n \"meta\": {\n \"results\": {\n \"total\": 3\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d8be504-e15a-4e4c-8d53-4f861841277e", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "GET", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc2b8f90-3799-4bfc-9f91-488f8aa06693", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "GET", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39533ff2-e8d4-4e9c-8daa-8e29cd97f431", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "GET", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9623a6ee-a607-4420-8f7f-0dff73ad9709", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "GET", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f090ca9-1564-4095-a768-6e15917a53c3", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "GET", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a7460f6-bda7-4fcf-b47f-999345789cbd", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" } ] }, "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": "GET", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_related_products\"\n },\n {\n \"type\": \"custom-relationship\",\n \"slug\": \"CRP_cart_products\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e468d092-c464-4fb7-8069-1fd5d9879976", "name": "Create a Relationship between a Product with one or more Products", "request": { "name": "Create a Relationship between a Product with one or more Products", "description": { "content": "- You can associate a product with up to 2000 other products. \n- You do not need to attach a custom relationship to products beforehand, this will be done automatically by this endpoint. \n- This is a partial update, so if you make a request to this endpoint multiple times with different products in each request, they will not be overwritten but will be appended to the related products list. \n\nIf you want to remove a relationship between products, see [Delete a Relationship between a product with one or more products](/docs/api/pxm/products/dissociate-products). \n\n ### Prerequisites\n - A Custom Relationship has been created, see [create a Custom Relationship](/docs/api/pxm/products/create-custom-relationship).\n - A Product has been created for the relationship to be based from.\n - One or many Product have been created for the product to relate to.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } }, { "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug", "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\",\n \"attributes\": {\n \"sort_order\": 5\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\",\n \"attributes\": {\n \"sort_order\": 2\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6003a936-29c9-4f33-9494-93be8e14bfd2", "name": "Returns information related to associated products.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\",\n \"attributes\": {\n \"sort_order\": 5\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\",\n \"attributes\": {\n \"sort_order\": 2\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"associated_products\": [\n \"68c48149-0e94-4ef2-93d5-8d5f3774980a\",\n \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n ],\n \"products_not_associated\": [\n {\n \"ID\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\",\n \"Details\": \"could not find product\"\n },\n {\n \"ID\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\",\n \"Details\": \"product already has 5 custom relationships, cannot associate more as it has reached the limit of 5 custom relationships\"\n },\n {\n \"ID\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\",\n \"Details\": \"product already has 5 custom relationships, cannot associate more as it has reached the limit of 5 custom relationships\"\n },\n {\n \"ID\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\",\n \"Details\": \"product exceeds the maximum limit of associated products (2000). Please review and try again\"\n }\n ],\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2024-08-08T09:29:08.295Z\",\n \"updated_at\": \"2024-08-08T09:29:08.295Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bcd6ef5-7cc0-46b1-9b1a-1c16e9975c65", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\",\n \"attributes\": {\n \"sort_order\": 5\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\",\n \"attributes\": {\n \"sort_order\": 2\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac88cffc-3ea9-4c26-a6ab-1e283603884f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\",\n \"attributes\": {\n \"sort_order\": 5\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\",\n \"attributes\": {\n \"sort_order\": 2\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2299b44e-96b2-480e-8221-93ef39d4bf0c", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\",\n \"attributes\": {\n \"sort_order\": 5\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\",\n \"attributes\": {\n \"sort_order\": 2\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf3abe0e-4d08-404d-99d4-5d26464117d0", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\",\n \"attributes\": {\n \"sort_order\": 5\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\",\n \"attributes\": {\n \"sort_order\": 2\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c456264e-7b4d-40ac-a056-5d946b0053c4", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\",\n \"attributes\": {\n \"sort_order\": 5\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\",\n \"attributes\": {\n \"sort_order\": 2\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f87780f5-5553-471e-a934-afc58d348358", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\",\n \"attributes\": {\n \"sort_order\": 5\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\",\n \"attributes\": {\n \"sort_order\": 2\n }\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60518d9d-7800-404f-be57-9ba7e6265061", "name": "Delete a Relationship between a product with one or more products", "request": { "name": "Delete a Relationship between a product with one or more products", "description": {}, "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } }, { "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug", "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\"\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\"\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7d7863f7-995d-41bc-bc3a-27de809ac333", "name": "Products are dissociated.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\"\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\"\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d8946d08-dc76-4bc2-aec2-3dc501b9ac8f", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\"\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\"\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "502ec09b-9de7-4760-b1b8-996ef5162c1f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\"\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\"\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "259c62db-6a03-479f-8c6a-35c296ec4a99", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\"\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\"\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4450b9a0-4181-4342-a8a2-6521d4291596", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\"\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\"\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "969b243b-44d3-4c35-911b-c7c1455ad45a", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\"\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\"\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d891768-4aed-42fe-9f74-16e3eecd08e7", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"product\",\n \"id\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\"\n },\n {\n \"type\": \"product\",\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\"\n },\n {\n \"type\": \"product\",\n \"id\": \"97b7fac2-91dd-4755-81b0-bdffe8e7eabd\"\n },\n {\n \"type\": \"product\",\n \"id\": \"a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99\"\n },\n {\n \"type\": \"product\",\n \"id\": \"bde79675-4783-40b7-8a7e-ac6df41459c6\"\n },\n {\n \"type\": \"product\",\n \"id\": \"aaddd5f4-a5f8-42e8-be9a-097986f22e58\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "decc90a2-db59-4829-837e-147c107b7676", "name": "Get all Related Product IDs of a Products' attached Custom Relationship", "request": { "name": "Get all Related Product IDs of a Products' attached Custom Relationship", "description": { "content": "### Prerequisites\n - Relationships have been created between Products, see [Create a Relationship between a product with one or more products](/docs/api/pxm/products/product-association-id).\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } }, { "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug", "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ce20e214-5b4e-4b7f-9564-69e558459c19", "name": "Returns all related product ids.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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\": \"68c48149-0e94-4ef2-93d5-8d5f3774980a\",\n \"type\": \"product\",\n \"attributes\": {\n \"sort_order\": 5\n }\n },\n {\n \"id\": \"ab4826d1-4a5a-4951-a2a5-98058899f891\",\n \"type\": \"product\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2d1c9bb-fbe5-4e2d-8995-dbeceffabdf4", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3583aadb-f596-4150-95c8-f2d6da267526", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6eae5d0-799f-41b3-9edd-b53978e38316", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5923d8c9-fcd3-4eae-84c6-f1e4f01da648", "name": "Write conflict detected", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Conflict\",\n \"status\": \"409\",\n \"detail\": \"write conflict detected\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca82db5c-cb16-4ecb-bf04-29adbb9ad3ba", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0d0c764-57c1-48c4-9697-d4992a796f0b", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55bcba12-f0f0-4736-b03a-f2245d9d6f0f", "name": "Get all Related Products of a Products' attached Custom Relationship", "request": { "name": "Get all Related Products of a Products' attached Custom Relationship", "description": { "content": "### Prerequisites\n - Relationships have been created between Products, see [Create a Relationship between a product with one or more products](/docs/api/pxm/products/product-association-id).\n", "type": "text/plain" }, "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID", "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" } }, { "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug", "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6ac70564-bb27-49af-af21-9f438afd47b0", "name": "Returns all related products.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"type\": \"product\",\n \"id\": \"9c85b276-09b4-488e-a59c-c561bae14c9e\",\n \"attributes\": {\n \"commodity_type\": \"physical\",\n \"custom_inputs\": {\n \"back\": {\n \"name\": \"T-Shirt Back\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n },\n \"front\": {\n \"name\": \"T-Shirt Front\",\n \"validation_rules\": [\n {\n \"type\": \"string\",\n \"options\": {\n \"max_length\": 50\n }\n }\n ],\n \"required\": false\n }\n },\n \"description\": \"T-shirt.\",\n \"mpn\": \"1234-5678-TTTT\",\n \"name\": \"T-Shirt\",\n \"sku\": \"97805\",\n \"slug\": \"97805\",\n \"status\": \"live\",\n \"upc_ean\": \"12345656\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"extensions\": {\n \"products(size)\": {\n \"widthMM\": 600,\n \"fuelType\": \"electric\",\n \"hasUKPlug\": true,\n \"online\": null\n }\n }\n },\n \"relationships\": {\n \"children\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/children\"\n }\n },\n \"component_products\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/component_products\"\n }\n },\n \"files\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/files\"\n }\n },\n \"main_image\": {\n \"data\": null\n },\n \"templates\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/templates\"\n }\n },\n \"variations\": {\n \"data\": [],\n \"links\": {\n \"self\": \"/products/9c85b276-09b4-488e-a59c-c561bae14c9e/relationships/variations\"\n }\n }\n },\n \"meta\": {\n \"created_at\": \"2022-08-18T14:25:57.391Z\",\n \"owner\": \"store\",\n \"product_types\": [\n \"standard\"\n ],\n \"updated_at\": \"2022-08-18T14:25:57.391Z\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 1\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0f81aa7-de91-4544-96cd-c0a39bd6e3ec", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1802c27b-3250-4f7a-bae8-2c40b2825553", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7b5d424-782a-4bb2-9b4b-0b5cb8e90f25", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30d7e56c-c7f8-4f6e-b6d7-340cc3d9a31a", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "053517aa-11fc-4606-a380-ef70f1073b00", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "products", ":productID", "custom-relationships", ":customRelationshipSlug", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) A unique identifier for the product.", "type": "text/plain" }, "type": "any", "value": "00000000-0000-0000-0000-000000000000", "key": "productID" }, { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Custom Relationships", "description": "", "item": [ { "id": "884d0aef-84d1-4676-abbc-baf415623cc3", "name": "Create a custom relationship", "request": { "name": "Create a custom relationship", "description": { "content": "Custom relationships can either be bi-directional or uni-directional.\n - **Uni-Directional**: By setting `bi_directional` to `false` (or omitted from request) a uni-directional custom relationship will be created. \n Within a uni-directional relationship, if Product A links to Product B, Product B will not link back to Product A. \n This is ideal when one product (e.g., a base product) recommends another (e.g., an upsell), but the reverse \n recommendation is unnecessary.\n \n - **Bi-Directional**: By setting `bi_directional` to `true` a bi-directional custom relationship will be created. Within a bi-directional \n relationship, if Product A is linked to Product B, Product B will automatically link back to Product A. \n This bi-directionality ensures a consistent experience, where products always suggest each other as related items.\n \n For more information on use cases, see [Custom Relationships](/guides/key-concepts/product-experience-manager/custom-relationships/).\n\nCustom Relationship slugs must meet the following criteria:\n - be unique \n - be prefixed with `CRP_`. Product Experience Manager automatically adds the `CRP_` prefix if you do not include it.\n - contain A to Z, a to z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed.\n \nOnce a custom relationship has been created, you can then create Product Relationships:\n 1. Add the custom relationship to a product. See [Attach a custom relationship to a product](/docs/api/pxm/products/attach-custom-relationships).\n 2. Associate a product to multiple products. See [Associate a product with other products under a custom relationship](/docs/api/pxm/products/product-association-id).\n", "type": "text/plain" }, "url": { "path": [ "pcm", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Kitchen electrics\",\n \"description\": \"Kitchen electric devices\",\n \"slug\": \"CRP_kitchen_individual_devices\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f49029cd-465d-4aed-9a32-2637425c244b", "name": "Returns a created custom relationship with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Kitchen electrics\",\n \"description\": \"Kitchen electric devices\",\n \"slug\": \"CRP_kitchen_individual_devices\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"f3297ee8-da90-45e9-ae56-a2654aebbdfe\",\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Kitchen electrics\",\n \"description\": \"Kitchen electric devices\",\n \"slug\": \"CRP_kitchen_individual_devices\",\n \"bi_directional\": false\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31998874-a27e-48f2-a47b-91349e599ae2", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Kitchen electrics\",\n \"description\": \"Kitchen electric devices\",\n \"slug\": \"CRP_kitchen_individual_devices\"\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8986c482-f6d2-4544-b563-46d8103cdb8a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Kitchen electrics\",\n \"description\": \"Kitchen electric devices\",\n \"slug\": \"CRP_kitchen_individual_devices\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8b7c69c-b4b4-44a4-b083-0949395876cf", "name": "Get all custom relationships", "request": { "name": "Get all custom relationships", "description": { "content": "Gets all Custom Relationships. \n\nTo see a list of custom relationships a product is attached to, see [Get all Custom Relationships attached to a Product](/docs/api/pxm/products/list-attached-custom-relationship).\n\nTo see a list of products that a product is related to, see [Get all Related Products of a Products' attached Custom Relationship](/docs/api/pxm/products/get-related-products-of-a-product-id).\n\n### Filtering\n\n Many Commerce API endpoints support filtering. The general syntax is described in [**Filtering**](/guides/Getting-Started/filtering).\n\n The following attributes and operators are supported.\n\n | Operator | Attribute | Description | Example |\n | :--- |:---|:---|:---|\n | `eq` | `owner`, `slug` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. | `filter=eq(owner,store)` |\n | `in` | `slug` | In. Checks if a value exists in a given list of values. If the value matches any item in the list, the condition is true. | `filter=in(slug,slug-1,slug-2,slug-3)` |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(owner,store)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8c20774b-463c-4205-b92b-01f7a692bf2c", "name": "Returns a list of all custom relationships.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(owner,store)" } ], "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\": \"f3297ee8-da90-45e9-ae56-a2654aebbdfe\",\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Kitchen electrics\",\n \"description\": \"Kitchen electric devices\",\n \"slug\": \"CRP_kitchen_individual_devices\",\n \"bi_directional\": false\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\"\n }\n }\n },\n {\n \"id\": \"21b1315b-c47f-4766-85bf-7bf0f94d73b6\",\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"bi_directional\": true\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\"\n }\n }\n },\n {\n \"id\": \"e390ff7e-efc4-4769-90d2-fceabcc1e2cd\",\n \"type\": \"custom-relationship\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"sort_order\": 5,\n \"external_name\": \"Similar items to consider\",\n \"external_description\": \"Check out these similar products that may also meet your needs or match your preferences.\",\n \"bi_directional\": false\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\"\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"/pcm/custom_relationships?page[offset]=29&page[limit]=1\",\n \"next\": \"/pcm/custom_relationships?page[offset]=1&page[limit]=1\"\n },\n \"meta\": {\n \"results\": {\n \"total\": 3\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcac62f8-07c5-4f28-b2ae-431dea343748", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(owner,store)" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2103f11d-f1d0-4890-a6cf-86a8c836ba28", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page. The maximum limit is 100.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n", "type": "text/plain" }, "key": "filter", "value": "eq(owner,store)" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d501a50-7e6a-4086-aaff-ccf668c117a6", "name": "Update a custom relationship", "request": { "name": "Update a custom relationship", "description": { "content": "Updates a custom relationship. \n\nA partial update can be performed, where you specify only the fields that need to be changed.\n\nThe custom relationship slug cannot be updated.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug", "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom-relationship\",\n \"id\": \"f3297ee8-da90-45e9-ae56-a2654aebbdfe\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"sort_order\": 5,\n \"external_name\": \"Similar items to consider\",\n \"external_description\": \"Check out these similar products that may also meet your needs or match your preferences.\",\n \"bi_directional\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3cb09a7b-29d7-4f0b-aa64-0d77d8769cf1", "name": "Successfully returns the updated custom relationship", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"data\": {\n \"type\": \"custom-relationship\",\n \"id\": \"f3297ee8-da90-45e9-ae56-a2654aebbdfe\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"sort_order\": 5,\n \"external_name\": \"Similar items to consider\",\n \"external_description\": \"Check out these similar products that may also meet your needs or match your preferences.\",\n \"bi_directional\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"custom-relationship\",\n \"id\": \"f3297ee8-da90-45e9-ae56-a2654aebbdfe\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"sort_order\": 5,\n \"external_name\": \"Similar items to consider\",\n \"external_description\": \"Check out these similar products that may also meet your needs or match your preferences.\",\n \"bi_directional\": false\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc408a67-cae4-4085-a5dd-b79669870acd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"data\": {\n \"type\": \"custom-relationship\",\n \"id\": \"f3297ee8-da90-45e9-ae56-a2654aebbdfe\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"sort_order\": 5,\n \"external_name\": \"Similar items to consider\",\n \"external_description\": \"Check out these similar products that may also meet your needs or match your preferences.\",\n \"bi_directional\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82cb5d70-60d1-44dc-bdd7-c3026f64db41", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"data\": {\n \"type\": \"custom-relationship\",\n \"id\": \"f3297ee8-da90-45e9-ae56-a2654aebbdfe\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"sort_order\": 5,\n \"external_name\": \"Similar items to consider\",\n \"external_description\": \"Check out these similar products that may also meet your needs or match your preferences.\",\n \"bi_directional\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a05d4e0-ed42-4ad2-b72e-10110d397c30", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"data\": {\n \"type\": \"custom-relationship\",\n \"id\": \"f3297ee8-da90-45e9-ae56-a2654aebbdfe\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"sort_order\": 5,\n \"external_name\": \"Similar items to consider\",\n \"external_description\": \"Check out these similar products that may also meet your needs or match your preferences.\",\n \"bi_directional\": false\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 \"errors\": [\n {\n \"title\": \"Failed Validation\",\n \"status\": \"422\",\n \"detail\": \" can not be empty\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab19ed0c-281e-44e9-868c-3df0498ea044", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"data\": {\n \"type\": \"custom-relationship\",\n \"id\": \"f3297ee8-da90-45e9-ae56-a2654aebbdfe\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"sort_order\": 5,\n \"external_name\": \"Similar items to consider\",\n \"external_description\": \"Check out these similar products that may also meet your needs or match your preferences.\",\n \"bi_directional\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfebf1cf-a3bc-4b28-b4df-bef1d9dd229d", "name": "Get a custom relationship", "request": { "name": "Get a custom relationship", "description": { "content": "Gets a Custom Relationship.\n\nTo see a list of custom relationships a product is attached to, see [Get all Custom Relationships attached to a Product](/docs/api/pxm/products/list-attached-custom-relationship).\n\nTo see a list of products that a product is related to, see [Get all Related Products of a Products' attached Custom Relationship](/docs/api/pxm/products/get-related-products-of-a-product-id).\n", "type": "text/plain" }, "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug", "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "946edbfc-00a8-41d9-97a8-f0b629f1fcc5", "name": "Returns a custom relationship with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"type\": \"custom-relationship\",\n \"id\": \"f3297ee8-da90-45e9-ae56-a2654aebbdfe\",\n \"attributes\": {\n \"name\": \"Related Products\",\n \"description\": \"A list of related products shown on the PDP\",\n \"slug\": \"CRP_related_products\",\n \"sort_order\": 5,\n \"external_name\": \"Similar items to consider\",\n \"external_description\": \"Check out these similar products that may also meet your needs or match your preferences.\",\n \"bi_directional\": false\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2024-01-10T20:16:35.343Z\",\n \"updated_at\": \"2024-01-10T20:16:35.343Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a7c7976-2ac6-479e-a132-f1448c7859d9", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f0ff682-aabc-4c18-bfeb-7271d4819804", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe06da8e-dcce-48ad-9626-793551762a27", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44fa006a-d615-4242-85fa-1cf528f16f40", "name": "Delete a custom relationship", "request": { "name": "Delete a custom relationship", "description": { "content": "Deletes the specified custom relationship.\n\nCustom Relationships cannot be deleted if they are in use.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug", "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "07c7f999-58c7-4a26-b481-80c884e7e27b", "name": "No Content", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "ce3bb0fd-31f5-4425-a755-d2f95f7c4019", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"detail\": \"Could not parse the supplied filter\",\n \"status\": \"400\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb9fdf46-31fb-49de-87f0-4a7949c7f33c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"errors\": [\n {\n \"title\": \"Forbidden\",\n \"status\": \"403\",\n \"detail\": \"entity owned by organization\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1769e6d4-a041-44b7-8e36-15d56590c38c", "name": "Bad Request. Not Found.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7f2f969-b8de-44c0-b921-6ee6743dc5d7", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "pcm", "custom-relationships", ":customRelationshipSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) A custom relationship slug.", "type": "text/plain" }, "type": "any", "value": "CRP_electric_devices_2024", "key": "customRelationshipSlug" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"500\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"There was an internal server error, you can report with your request id.\",\n \"request_id\": \"635da56d-75a1-43cd-b696-7ab119756b3a\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Price Books", "description": "Price books contain prices for the products in your catalog. Each catalog must have one price book. In your storefront, the product prices are displayed in the currency for the selected locale. If a product in the catalog does not have a price in the price book, the product is displayed without a price. \n\nA price book can be associated with multiple catalogs.\n\nFollowing on from this, you can associate more than one price book with a catalog. Price book stacking allows you to create multiple price books for different scenarios, such as seasonal sales, business versus retail customer pricing, and reward programs. If you have multiple price books, when you create a catalog, you must configure a priority for your price books. Product prices are displayed in the catalog according to the priority of the price books. For example, you may have products that have different prices based on region. You can have a price book with the standard retail pricing and then have a second price book that has different pricing for a different region. See Create a catalog.\n\nA price book contains a list of product SKUs and the prices you want to charge for those products. If your store supports multiple locales, a price book can contain product prices in each of the supported currencies. In addition, you can configure sales and volume (tier) pricing.\n\n:::note\n\nPrice books work with products that are defined using the Product Experience Manager resource model. If your products are defined using an earlier Products resource model, you will need to migrate products to the `pcm/products` resource before you implement price books.\n\n:::\n\nYou can duplicate an existing price book and create a new price book. All products and prices associated with the price book are copied to the new price book. Based on the business requirements, you can use the same data or update the data.\n", "item": [ { "id": "13b825ba-37ac-4986-8bcd-2371d7927ba2", "name": "Create a Price Book", "request": { "name": "Create a Price Book", "description": { "content": "Creates a price book. You can add the prices to the price book now or update the price book later.", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"attributes\": {\n \"external_ref\": \"an-external-ref\",\n \"description\": \"This is a test price book\",\n \"name\": \"Standard Price Book\"\n },\n \"type\": \"pricebook\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8791c25a-3191-4a68-8d18-59953169dc0d", "name": "A price book with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"attributes\": {\n \"external_ref\": \"an-external-ref\",\n \"description\": \"This is a test price book\",\n \"name\": \"Standard Price Book\"\n },\n \"type\": \"pricebook\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\",\n \"type\": \"pricebook\",\n \"attributes\": {\n \"name\": \"Standard Price Book\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"external_ref\": \"an-external-ref\",\n \"description\": \"This is a test price book\"\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n },\n \"links\": {\n \"self\": \"http://GRrBz.jvffP2TsJiH1YJErtUGU07kqwyjiFMuQYn9bWwMX-FgI4lcrnLHYLYij,DXfwDGs4l2AwjmwqY\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d26b568c-35e9-46ea-b020-a9daf621de3d", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"attributes\": {\n \"external_ref\": \"an-external-ref\",\n \"description\": \"This is a test price book\",\n \"name\": \"Standard Price Book\"\n },\n \"type\": \"pricebook\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b742f252-33c5-453a-ac70-a42f8ad68c1a", "name": "Get all Price Books", "request": { "name": "Get all Price Books", "description": { "content": "Retrieves a list of all price books.\n\n### Filtering\n\nFiltering is supported on this endpoint. For the general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\n You can filter on the following attributes and operators.\n\n | Operator | Attribute | Description | Example |\n | --- | --- | --- | --- |\n | `eq` | `external_ref` | Equals. Checks if the values you provide matches a price book. | `filter=eq(external_ref,some-external-ref)` |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "You can filter on this endpoint. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "6946" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2321" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "357e1da9-2d7b-4d68-a0db-fb274dbe575e", "name": "The list of price books.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "You can filter on this endpoint. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "6946" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2321" } ], "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\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\",\n \"type\": \"pricebook\",\n \"attributes\": {\n \"name\": \"Standard Price Book\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"external_ref\": \"an-external-ref\",\n \"description\": \"This is a test price book\"\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n },\n {\n \"id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\",\n \"type\": \"pricebook\",\n \"attributes\": {\n \"name\": \"Standard Price Book\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"external_ref\": \"an-external-ref\",\n \"description\": \"This is a test price book\"\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 1\n },\n \"page\": {\n \"limit\": 10,\n \"offset\": 0,\n \"current\": 0,\n \"total\": 1\n }\n },\n \"links\": {\n \"self\": \"https://eS.skbhP3,pQpoBmG7Ewa3\",\n \"first\": \"https://Qsu.vecp7own4J47QsDHK.P5-+Ta5Ztd2nKZBulCPYDU+Xwpv2xjO1wwKsUr6QHpvNV9dzy\",\n \"last\": \"https://xhMaezUtBabcjJz.uuucdmHGcK9fY94soIKF\",\n \"prev\": \"http://JccwRlcNDzALDKqtSVxkSrFZreFqQt.hhpFPOpyndCr0\",\n \"next\": \"https://cBaWfn.nlexE44fmxNAcNWA02YTr8SBUoZWfAqWGHMp2cvT\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5379fb74-8c1b-4f54-802a-e826d6e75fd3", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "You can filter on this endpoint. See [Filtering](#filtering).\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "6946" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2321" } ], "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8a1a263-e32d-4f05-8a44-1d01cbef337b", "name": "Get a Price Book by ID", "request": { "name": "Get a Price Book by ID", "description": { "content": "Retrieves the specified price book. To include prices in the response, append `?include=prices` to the path.", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "To include product prices in a response, add `include=prices`. (This can only be one of prices)", "type": "text/plain" }, "key": "include", "value": "prices" } ], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "31c454e5-7c6c-46a3-9301-4f0293f53a5a", "name": "The price book.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "To include product prices in a response, add `include=prices`. (This can only be one of prices)", "type": "text/plain" }, "key": "include", "value": "prices" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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 \"id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\",\n \"type\": \"pricebook\",\n \"attributes\": {\n \"name\": \"Standard Price Book\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"external_ref\": \"an-external-ref\",\n \"description\": \"This is a test price book\"\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n },\n \"links\": {\n \"self\": \"https://tUaZREAyFnxL.qbkAOt5TtGuqwJiw0S9zjIV2rzARawsyergogKoPDBCIFm5JedZzaMeqAVfzH,,tFDuelU7w6\"\n },\n \"included\": [\n {\n \"type\": \"product-price\",\n \"attributes\": {\n \"sku\": \"product-sku-a\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n },\n \"id\": \"a915553d-935d-4d56-870b-817b47a44a99\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\",\n \"pricebook_id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\"\n }\n },\n {\n \"type\": \"product-price\",\n \"attributes\": {\n \"sku\": \"product-sku-a\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n },\n \"id\": \"a915553d-935d-4d56-870b-817b47a44a99\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\",\n \"pricebook_id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2190172-4775-49ad-b253-d10d7f5da1d4", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "To include product prices in a response, add `include=prices`. (This can only be one of prices)", "type": "text/plain" }, "key": "include", "value": "prices" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5aab937-be98-4b71-bae8-8c38f01d91ad", "name": "Update a Price Book by ID", "request": { "name": "Update a Price Book by ID", "description": { "content": "Updates the specified price book. Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the price book is not updated.", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\",\n \"type\": \"pricebook\",\n \"attributes\": {\n \"description\": \"This is a price book\",\n \"name\": \"pricebook-store-abc\",\n \"external_ref\": \"external-ref\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "74bd77fd-4574-4579-af1e-6b74e753e539", "name": "An updated price book with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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 \"data\": {\n \"id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\",\n \"type\": \"pricebook\",\n \"attributes\": {\n \"description\": \"This is a price book\",\n \"name\": \"pricebook-store-abc\",\n \"external_ref\": \"external-ref\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\",\n \"type\": \"pricebook\",\n \"attributes\": {\n \"name\": \"Standard Price Book\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"external_ref\": \"an-external-ref\",\n \"description\": \"This is a test price book\"\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n },\n \"links\": {\n \"self\": \"http://GRrBz.jvffP2TsJiH1YJErtUGU07kqwyjiFMuQYn9bWwMX-FgI4lcrnLHYLYij,DXfwDGs4l2AwjmwqY\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "024b1917-69d1-43f1-b3ff-1bb4cfd30d0d", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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 \"data\": {\n \"id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\",\n \"type\": \"pricebook\",\n \"attributes\": {\n \"description\": \"This is a price book\",\n \"name\": \"pricebook-store-abc\",\n \"external_ref\": \"external-ref\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e098ae1a-c228-4c70-8180-fde064a8b1ae", "name": "Delete a Price Book by ID", "request": { "name": "Delete a Price Book by ID", "description": { "content": "Deletes the specified price book and all prices in the price book. It does not delete the products. In addition, pricing details in the orders referring to the deleted price book are not deleted.", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "42f3efe6-239d-48a9-b2ee-7720e5724e8a", "name": "A 204 response indicates that the price book has been deleted.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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": "36f9d504-fb16-4661-9564-7a182b759cd1", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f83d195c-c1d4-45ba-8ac6-1ebf8d709317", "name": "Replicate a Price Book", "request": { "name": "Replicate a Price Book", "description": { "content": "Using this endpoint, you can replicate an existing price book. This is useful because it enables you to quickly and easily create multiple price books with the same pricing structure. When you replicate an existing price book, you can specify a new name, description, and external reference for the replicated price book. Other attributes stay the same.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "replicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"pricebook\",\n \"attributes\": {\n \"description\": \"This is a test price book\",\n \"name\": \"pricebook-store-abc\",\n \"external_ref\": \"external-ref\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a86cd177-0622-45cf-a1d4-e60dfc984f35", "name": "A replicated price book with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "replicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"pricebook\",\n \"attributes\": {\n \"description\": \"This is a test price book\",\n \"name\": \"pricebook-store-abc\",\n \"external_ref\": \"external-ref\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\",\n \"type\": \"pricebook\",\n \"attributes\": {\n \"name\": \"Standard Price Book\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"external_ref\": \"an-external-ref\",\n \"description\": \"This is a test price book\"\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n },\n \"links\": {\n \"self\": \"http://GRrBz.jvffP2TsJiH1YJErtUGU07kqwyjiFMuQYn9bWwMX-FgI4lcrnLHYLYij,DXfwDGs4l2AwjmwqY\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f5c4529-6bd9-43a9-a8f8-ad29d7ed3673", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "replicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"pricebook\",\n \"attributes\": {\n \"description\": \"This is a test price book\",\n \"name\": \"pricebook-store-abc\",\n \"external_ref\": \"external-ref\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Prices", "description": "Price books contain prices for the products in your catalog. Use the Price Books API to create price books and add product prices to the price book.\n\n### Volume (tiers) Pricing\n\nUsing volume (tiers) pricing allows your store to offer different pricing for minimum quantities of items that your customers purchase. When a customer adds sufficient quantity of an item and meets the minimum required quantity for different pricing, all products with that item SKU are discounted in the cart. You can define the price range for different quantities of different items as in the following example:\n\n| Quantity | Price/Each |\n|:---------|:-----------|\n| 1-5 | $10.50 |\n| 6-10 | $10.00 |\n| 11-20 | $9.50 |\n| 21-50 | $8.50 |\n| 51+ | $7.90 |\n\n### Sales Pricing\n\nWith sales pricing, a store can optionally add a sale price to a product price. For example, a store can schedule seasonal pricing on products without creating a new price book and catalog ruleset. Optionally, a store can schedule the date ranges for the sale products. \n\nYou can set a sale price for an item within a bundle so that the product is sold at the sale price when sold as part of the bundle. For example, if you have a bundle consisting of four items, you can apply a discounted price to an item within the bundle to get a bundle sales price. \n\n1. For sale prices in the same price book:\n\n - the schedules must not be exactly the same.\n - schedules can partially overlap. If the schedule does contain overlapping sales prices, the sale price of the smallest sale period is chosen.\n - if you have just one sale price, without a schedule, this is effectively a permanent price. If you want to add more sale prices to the price book, you must configure a schedule for the sale price. \n\n2. Sale prices in different price books can have overlapping schedules.\n\nBoth list and sale price (or was/is prices) are available in the catalog response, enabling you to display slash pricing on your storefront, depending on your requirements.\n\n### Creating a bundle sale price\n\nYou can assign a sale price to an option in a bundle.\n\n1. In the product price book, create a sale.\n2. Specify the bundle ID that contains the option you want to provide a sale price for.\n3. Provide the sale price for the option. You can add the same sale price for the same option using an array of bundle_ids if you want to sell the product as part of different bundles.\n\n### Understanding Volume and Sale Pricing Behavior for Products\n\nIf you have configured both sale and volume pricing for your products and product bundles, the following table describes how pricing behaves in the following scenarios.\n\n| Scenario | Description |\n| --- | --- |\n| Minimum quantities for volume pricing and sale pricing |
  • (With sale schedule) If you have specified a minimum quantity of five whose price is $0.99 and at the same time, you have configured a sale for the time of purchase, then when a shopper checks out with 5 or more items, the total is based on the volume pricing. In other words, $0.99 × 5 = $4.95. Additionally, if volume pricing exist for both the product price and the sale, the volume pricing for the sale takes precedence. If no volume pricing is set in the sale, the base sale price is applied, and the volume pricing for the product price will not be applied.
  • (With sale schedule) If a shopper's items in the cart do not meet the minimum quantity required for volume pricing, the total is calculated based on the sales price.
  • (Without sale schedule) If the sale is a permanent sale and volume pricing is only set for the product price, then regardless of the quantity a shopper adds to a cart, the final price is always calculated based on the base sales price. However, if volume pricing has been set for the sale, the final price will be determined by the volume tier pricing set in the sale, not the base sales price.
\n| Two levels of volume pricing with different prices for each volume. | If you have configured two levels of volume pricing, for example, the first minimum quantity is 5 and the second minimum quantity is 10:
  • When the quantity in the cart is => 5, then the price for the minimum quantity of 5 is used.
  • When the quantity in the cart is => 10 then the price for the minimum quantity of 10 is used.
|\n\n### Optimizing product prices\n\nYou can add custom attributes to a product price, allowing your storefront to dynamically use these attributes in it's pricing and display logic. This enables you to optimize your pricing data, enhancing your ability to respond to market dynamics and customer preferences. Some examples of pricing optimization strategies are:\n\n- dynamic pricing - allows you to change the price of a product based on changes in customer demand, for example, raising prices during the high-demand holiday season or segment-focused, like special offers for new customers.\n- value-based pricing - allows you to offer different pricing tiers, for example, \"pro\" features cost more.\n- cost-plus pricing - allows you to set prices by adding a specific percentage to the production cost of a single unit.\n\nThere are two types of custom attributes:\n\n- `admin_attributes` - `admin_attributes` are not displayed in catalogs. This means `admin-attributes` can only be viewed by administrators. For example, you may want to add custom attributes that can automate price updates based on predefined rules, saving time and reducing human error or you might want to integrate price attributes with your other company systems, (ERP, CRM) ensuring consistency and accuracy across platforms.\n- `shopper_attributes` - `shopper_attributes` are displayed in catalogs. This means `shopper_attributes` can be viewed by both shoppers and administrators. For example, you can set prices based on customer segments, offering different prices for wholesale and retail customers or providing discounts to loyal customers. \n\nBoth `admin-attributes` and `shopper_attributes` are structured as key-value pairs. Both the keys and values are `strings`. You can have up to 100 keys for each type of attribute.\n", "item": [ { "id": "2daf2235-2706-4768-bf3a-84ab4674e247", "name": "Add a Product Price to a Price Book", "request": { "name": "Add a Product Price to a Price Book", "description": { "content": "Price books contain prices for the products in your catalog. Use the Prices API to adds the prices for a product to a specified price book. If the prices for the product already exist in the price book, the operation fails and the existing product prices are not updated.", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-price\",\n \"attributes\": {\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sku\": \"product-sku-a\",\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"a-external-ref\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "da54d20a-0915-4238-a080-29e3d20be792", "name": "A product price with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-price\",\n \"attributes\": {\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sku\": \"product-sku-a\",\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"a-external-ref\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"product-price\",\n \"attributes\": {\n \"sku\": \"product-sku-a\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n },\n \"id\": \"a915553d-935d-4d56-870b-817b47a44a99\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\",\n \"pricebook_id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\"\n }\n },\n \"links\": {\n \"self\": \"http://miYoJEKdEpDFKwhBMbOpScrozZwORule.qnDqifz.gKdGbjpBRQhenzH0gNFSmEQsMiKfMiS,0vGxU0MFmHgFzD\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6334608-dda9-41d0-b1af-0749a49afa53", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-price\",\n \"attributes\": {\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sku\": \"product-sku-a\",\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"a-external-ref\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The price already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The price already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "45563757-f40d-4eb2-9e7b-70aff70226fa", "name": "Gets all Prices by Price Book ID", "request": { "name": "Gets all Prices by Price Book ID", "description": { "content": "Retrieves all the product prices in the specified price book.\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\n| Operator | Attribute | Description | Example |\n| --- | --- | --- | --- |\n| `eq` | `external_ref`, `sku` | Checks if the values you provide matches a price. | `filter=eq(sku,some-sku)` |\n| `in` | `sku` | Checks if the values you provide are included in a product SKU. | `filter=in(sku,some-sku)' |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering. See [Filtering]().\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "6946" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2321" } ], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b2537252-402d-46c3-b88e-be9e27f108c5", "name": "The product price list.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering. See [Filtering]().\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "6946" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2321" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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 \"type\": \"product-price\",\n \"attributes\": {\n \"sku\": \"product-sku-a\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n },\n \"id\": \"a915553d-935d-4d56-870b-817b47a44a99\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\",\n \"pricebook_id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\"\n }\n },\n {\n \"type\": \"product-price\",\n \"attributes\": {\n \"sku\": \"product-sku-a\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n },\n \"id\": \"a915553d-935d-4d56-870b-817b47a44a99\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\",\n \"pricebook_id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 1\n },\n \"page\": {\n \"limit\": 10,\n \"offset\": 0,\n \"current\": 0,\n \"total\": 1\n }\n },\n \"links\": {\n \"self\": \"http://uILEB.wsehJvr\",\n \"first\": \"https://qtCbQhhHkWWWbcCcREdirIzvCA.waypWigjdJnMscUVEx+ttj8vE23GHEhIWU37HGMAf\",\n \"last\": \"https://WOETPhvcWqLMEoBO.wdyZDyqbiRXOxp+g9+lFUl61BZfBeQ,F9zwwelMMu7KMKl5+EA\",\n \"prev\": \"http://BHTfbOXNINc.gflxGoQ.RUGra-Vm6eO7Mj6IBRsdIZ8kYSjiPaS-SmllwTFVweHGo-r7ZoutJVHlNeM\",\n \"next\": \"https://yEhrjftcLrH.hwXhblLGa8mBq.kD+vrsFct4qTuVnbQO++b-huHJhsCJ,\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b9923c2-e0c1-424c-a44e-2dd5eb3b727f", "name": "Unexpected error", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering. See [Filtering]().\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "6946" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2321" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The price already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The price already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "91fae95f-f11c-4870-82cd-6250806c1eb8", "name": "Get a Product Price by Price Book ID", "request": { "name": "Get a Product Price by Price Book ID", "description": { "content": "Retrieves a specified product price (`priceId`) in the specified price book (`id`).", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices", ":priceID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "priceID", "disabled": false, "description": { "content": "(Required) A unique identifier of a price book price.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b310176c-d588-4b75-90e1-ae602c47d1f8", "name": "The product price.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices", ":priceID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier of a price book price.", "type": "text/plain" }, "type": "any", "value": "string", "key": "priceID" } ] }, "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 \"type\": \"product-price\",\n \"attributes\": {\n \"sku\": \"product-sku-a\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n },\n \"id\": \"a915553d-935d-4d56-870b-817b47a44a99\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\",\n \"pricebook_id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\"\n }\n },\n \"links\": {\n \"self\": \"http://miYoJEKdEpDFKwhBMbOpScrozZwORule.qnDqifz.gKdGbjpBRQhenzH0gNFSmEQsMiKfMiS,0vGxU0MFmHgFzD\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "552a65bb-f87f-414e-89f4-8c277465307a", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices", ":priceID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier of a price book price.", "type": "text/plain" }, "type": "any", "value": "string", "key": "priceID" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The price already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The price already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53767edc-3ade-4c07-970c-0155dd088786", "name": "Update a Product Price in a Price Book", "request": { "name": "Update a Product Price in a Price Book", "description": { "content": "Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the price is not updated.", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices", ":priceID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "priceID", "disabled": false, "description": { "content": "(Required) A unique identifier of a price book price.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"product-price\",\n \"attributes\": {\n \"sku\": \"product-sku-a\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n },\n \"id\": \"a915553d-935d-4d56-870b-817b47a44a99\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\",\n \"pricebook_id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\"\n }\n },\n \"links\": {\n \"self\": \"http://miYoJEKdEpDFKwhBMbOpScrozZwORule.qnDqifz.gKdGbjpBRQhenzH0gNFSmEQsMiKfMiS,0vGxU0MFmHgFzD\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2a06a9d0-2956-4425-8dfb-819f65b7b68a", "name": "An updated product price with the following attributes.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices", ":priceID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier of a price book price.", "type": "text/plain" }, "type": "any", "value": "string", "key": "priceID" } ] }, "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 \"data\": {\n \"type\": \"product-price\",\n \"attributes\": {\n \"sku\": \"product-sku-a\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n },\n \"id\": \"a915553d-935d-4d56-870b-817b47a44a99\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\",\n \"pricebook_id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\"\n }\n },\n \"links\": {\n \"self\": \"http://miYoJEKdEpDFKwhBMbOpScrozZwORule.qnDqifz.gKdGbjpBRQhenzH0gNFSmEQsMiKfMiS,0vGxU0MFmHgFzD\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"product-price\",\n \"attributes\": {\n \"sku\": \"product-sku-a\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n },\n \"id\": \"a915553d-935d-4d56-870b-817b47a44a99\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\",\n \"pricebook_id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\"\n }\n },\n \"links\": {\n \"self\": \"http://miYoJEKdEpDFKwhBMbOpScrozZwORule.qnDqifz.gKdGbjpBRQhenzH0gNFSmEQsMiKfMiS,0vGxU0MFmHgFzD\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aad80a73-f324-48c7-9883-a01cac034469", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices", ":priceID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier of a price book price.", "type": "text/plain" }, "type": "any", "value": "string", "key": "priceID" } ] }, "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 \"data\": {\n \"type\": \"product-price\",\n \"attributes\": {\n \"sku\": \"product-sku-a\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n },\n \"id\": \"a915553d-935d-4d56-870b-817b47a44a99\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\",\n \"pricebook_id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\"\n }\n },\n \"links\": {\n \"self\": \"http://miYoJEKdEpDFKwhBMbOpScrozZwORule.qnDqifz.gKdGbjpBRQhenzH0gNFSmEQsMiKfMiS,0vGxU0MFmHgFzD\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The price already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The price already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "278aefa9-9cac-4d09-963e-07ab02ce6463", "name": "Delete a Product Price from a Price Book", "request": { "name": "Delete a Product Price from a Price Book", "description": { "content": "Deletes a product price from the specified price book.", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices", ":priceID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "priceID", "disabled": false, "description": { "content": "(Required) A unique identifier of a price book price.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "a94b2f26-539a-49da-a33f-14359fcc4c8b", "name": "A 204 response indicates that the product prices have been deleted", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices", ":priceID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier of a price book price.", "type": "text/plain" }, "type": "any", "value": "string", "key": "priceID" } ] }, "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": "d8dbe276-ec69-44d4-982d-98c1a118363e", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "prices", ":priceID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a price book.", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" }, { "disabled": false, "description": { "content": "(Required) A unique identifier of a price book price.", "type": "text/plain" }, "type": "any", "value": "string", "key": "priceID" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The price already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The price already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc1e2b63-ac83-44e6-8cfc-86d22661851b", "name": "Gets all Prices", "request": { "name": "Gets all Prices", "description": { "content": "Allows you to retrieve all prices for a product, irrespective of the different price books that include that product's price. For example, you can filter for all prices for a specified `sku`, or filter for all prices changed before or after a given date. This will retrieve prices from all price books.\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\n| Operator | Attribute | Description | Example |\n| --- | --- | --- | --- |\n| `eq` | `external_ref`, `sku`, `id` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. | `filter=eq(sku,some-sku)` |\n| `in` | `external_ref`, `sku`, `id` | In. Checks if the values are included in the specified list. If they are, the condition is true. | `filter=in(sku,some-sku)` |\n| `like` | `external_ref`, `sku` | Like. Checks if the operand contains the specified string. Wildcards are supported. | `filter=like(sku,some-sku)` |\n| `gt` | `updated_at`, `created_at` | Greater than. Checks if the value on the left of the operator is greater than the value on the right. If it is, the condition is true. | `filter=gt(updated_at,2018-04-16T10:11:59.715Z)` |\n| `lt` | `updated_at`, `created_at` | Less than. Checks if the value on the left of the operator is less than the value on the right. If it is, the condition is true. | `filter=lt(updated_at,2018-04-16T10:11:59.715Z)` |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", "prices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering. See [Filtering]().\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "6946" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2321" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c06fb411-b947-462d-ba96-5c94c8d05691", "name": "The price list.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", "prices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering. See [Filtering]().\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "6946" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2321" } ], "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 \"type\": \"product-price\",\n \"attributes\": {\n \"sku\": \"product-sku-a\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n },\n \"id\": \"a915553d-935d-4d56-870b-817b47a44a99\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\",\n \"pricebook_id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\"\n }\n },\n {\n \"type\": \"product-price\",\n \"attributes\": {\n \"sku\": \"product-sku-a\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"sales\": {\n \"summer\": {\n \"schedule\": {\n \"valid_form\": \"2023-12-24T09:00:00\",\n \"valid_to\": \"2023-12-25T09:00:00\"\n },\n \"currencies\": {\n \"USD\": {\n \"amount\": 90,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 40\n }\n }\n },\n \"CAD\": {\n \"amount\": 117,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 80\n }\n }\n },\n \"GBP\": {\n \"amount\": 65,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 50\n }\n }\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"admin_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n },\n \"shopper_attributes\": {\n \"cost_of_goods\": \"42.0\",\n \"charge_type\": \"credit card\"\n }\n },\n \"id\": \"a915553d-935d-4d56-870b-817b47a44a99\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\",\n \"pricebook_id\": \"4c45e4ec-26e0-4043-86e4-c15b9cf985a7\"\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"limit\": 10,\n \"offset\": 0,\n \"current\": 0,\n \"total\": 1\n }\n },\n \"links\": {\n \"self\": \"https://oQYlxaCSgzwyXUJsibUawOMaLzSQoyx.swdghgVeAtLxAmDpY2+ZBX2OXC5NQi8rtZ+QGPjroQ015cX2-1f-viG.q,42uH8C9N\",\n \"first\": \"http://uDShZQbctkMOdjiNCnAwTAsZdyV.qxbX8D.RW5Sh\",\n \"prev\": \"http://MNRBdZKKhSqfHlSmG.htV-Pd3SakkJBtyDN+JC2OUMVC8CN5v00N45xV5Fd8apz7RaVBVpbgQsfX8++EAAEiLFzpP2DjnVGF+nMa\",\n \"next\": \"http://JkMgzxxLyVTJUEtVKBRHcTnc.aoyGjZtUCrRiZlxfKmrhg6GPtt8erHTFERektdq8o,OfjMGx7jXQHe.ou\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c54a74b-6511-46df-8fdc-2bcae09dcd13", "name": "Unexpected error", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", "prices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering. See [Filtering]().\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "6946" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2321" } ], "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The price already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The price already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Price Book Modifiers", "description": "You can use price modifiers to change the price property of child products. By default, child products inherit the same price as their base products. Using price modifiers, you can enable child products to inherit a different price. This enables you to configure the price of child products, for example, to be lower than its base product, without having to individually update the price of your child products. There are three types of price modifier.\n\n| Modifier | Data Type | Effect |\n|:------------------|:----------|:---------------------------------------------|\n| `price_increment` | `string` | Increases the price of a product. |\n| `price_decrement` | `string` | Decreases the price of a product. |\n| `price_equals` | `string` | Sets the price of a product to the amount you specify. |\n\nThe following is an overview of the steps you need to follow to use price modifiers.\n\n1. Create a price modifier. You must give the price modifier a unique name. For more information, see [Create a Price Modifier](/docs/api/pxm/pricebooks/create-price-modifier).\n1. Build your child products with the new product modifier.\n", "item": [ { "id": "65301812-bf0f-4005-8816-1e892bb0a549", "name": "Create a Modifier", "request": { "name": "Create a Modifier", "description": { "content": "You can use price modifiers to change the price property of child products. By default, child products inherit the same price as their base products. Using price modifiers, you can enable child products to inherit a different price. This enables you to configure the price of child products, for example, to be lower than its base product, without having to individually update the price of your child products. There are three types of price modifier.", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price-modifier\",\n \"attributes\": {\n \"name\": \"large-supplement\",\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"external_ref\": \"external-ref\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9474f7b4-1389-474f-bda6-95e61adb04a7", "name": "The created price modifier", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price-modifier\",\n \"attributes\": {\n \"name\": \"large-supplement\",\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"external_ref\": \"external-ref\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"price-modifier\",\n \"attributes\": {\n \"name\": \"large-supplement\",\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\"\n },\n \"id\": \"37f2eed6-0bea-4d0b-a3c6-24cc76143bfd\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\"\n }\n },\n \"links\": {\n \"self\": \"http://LlEGkeMJpnVfeqXMZDTPF.mfqAJ9is4XlDA+3LvBScKguubqhCh1\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64205163-66bf-426c-a279-f1c805bc2424", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price-modifier\",\n \"attributes\": {\n \"name\": \"large-supplement\",\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"external_ref\": \"external-ref\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The modifier already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The modifier already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e054c253-cd84-40ac-a1d0-c41c584402df", "name": "Gets a list of all modifiers", "request": { "name": "Gets a list of all modifiers", "description": { "content": "Retrieves a list of price modifiers for the specified price book.\n\n### Filtering\n\nFiltering is supported on this endpoint. For the general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\nYou can filter on the following attributes and operators.\n\n| Operator | Attribute | Description | Example |\n| --- | --- | --- | --- |\n| `eq` | `external_ref`, `name` | Checks if the values you provide matches a price modifier. | `filter=eq(name,largesupplement)` |\n", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering. See [Filtering]().\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "6946" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2321" } ], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0760793c-8616-4e49-abc9-676aec17474a", "name": "The price modifier list.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering. See [Filtering]().\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "6946" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2321" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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 \"type\": \"price-modifier\",\n \"attributes\": {\n \"name\": \"large-supplement\",\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\"\n },\n \"id\": \"37f2eed6-0bea-4d0b-a3c6-24cc76143bfd\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\"\n }\n },\n {\n \"type\": \"price-modifier\",\n \"attributes\": {\n \"name\": \"large-supplement\",\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\"\n },\n \"id\": \"37f2eed6-0bea-4d0b-a3c6-24cc76143bfd\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\"\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 1\n },\n \"page\": {\n \"limit\": 10,\n \"offset\": 0,\n \"current\": 0,\n \"total\": 1\n }\n },\n \"links\": {\n \"self\": \"https://qvxtFzejlbTRBi.uoyw7I7FaE4lVMeWNmv0YALuCI7pHPNzfjfI9oHxSD6C2mEYM0r7JOEN4hFsHAoK-mLfFsFd5\",\n \"first\": \"http://mZFSKEqOnfAhc.fkRTt1DgDlHE8mx,CIw4dz5LgK\",\n \"last\": \"http://KQPietbXFNIpmGRVNLXehmozeYbyu.rob,L4ZxwD,b\",\n \"prev\": \"https://IMg.ereeMCORCTPZ8hPEzj3XJQZWyeGpyDEiqPyJMlqMw0J9Nro\",\n \"next\": \"https://WL.ueuJ.qO5OR3n3RWRs6NoB-Gu1maButtowpbTc-jqQXFyxFruyP\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd5ff735-1184-4358-831a-828ee707d5a3", "name": "Unexpected error", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This endpoint supports filtering. See [Filtering]().\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "6946" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the [**page length**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "2321" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The modifier already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The modifier already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7b82d16-7807-4d5b-aa8d-eaadbe34f60a", "name": "Get a Modifier", "request": { "name": "Get a Modifier", "description": { "content": "Retrieves the specified price book modifier from the specified price book.", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "modifierID", "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book Modifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "988c28b5-0c44-44e2-9f08-5a6609d4dee0", "name": "The price modifier.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" }, { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book Modifier", "type": "text/plain" }, "type": "any", "value": "string", "key": "modifierID" } ] }, "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 \"type\": \"price-modifier\",\n \"attributes\": {\n \"name\": \"large-supplement\",\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\"\n },\n \"id\": \"37f2eed6-0bea-4d0b-a3c6-24cc76143bfd\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\"\n }\n },\n \"links\": {\n \"self\": \"http://LlEGkeMJpnVfeqXMZDTPF.mfqAJ9is4XlDA+3LvBScKguubqhCh1\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb691264-5d0b-4f23-9441-a7db8af9fb70", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" }, { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book Modifier", "type": "text/plain" }, "type": "any", "value": "string", "key": "modifierID" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The modifier already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The modifier already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b099ffa0-1cfc-413d-9d3d-71905cb67896", "name": "Update a Modifier", "request": { "name": "Update a Modifier", "description": { "content": "Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the price modifier is not updated.", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "modifierID", "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book Modifier", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"37f2eed6-0bea-4d0b-a3c6-24cc76143bfd\",\n \"type\": \"price-modifier\",\n \"attributes\": {\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"name\": \"large-supplement\",\n \"modifier_type\": \"price_equals\",\n \"external_ref\": \"external-ref\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "38895d70-8289-434c-a255-db7f397eb06d", "name": "Updated price modifier.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" }, { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book Modifier", "type": "text/plain" }, "type": "any", "value": "string", "key": "modifierID" } ] }, "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 \"data\": {\n \"id\": \"37f2eed6-0bea-4d0b-a3c6-24cc76143bfd\",\n \"type\": \"price-modifier\",\n \"attributes\": {\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"name\": \"large-supplement\",\n \"modifier_type\": \"price_equals\",\n \"external_ref\": \"external-ref\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"price-modifier\",\n \"attributes\": {\n \"name\": \"large-supplement\",\n \"modifier_type\": \"price_equals\",\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"external_ref\": \"external-ref\",\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\"\n },\n \"id\": \"37f2eed6-0bea-4d0b-a3c6-24cc76143bfd\",\n \"pricebook_external_ref\": \"a-pricebook-external-ref\",\n \"meta\": {\n \"owner\": \"store\"\n }\n },\n \"links\": {\n \"self\": \"http://LlEGkeMJpnVfeqXMZDTPF.mfqAJ9is4XlDA+3LvBScKguubqhCh1\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "257f0e10-2af8-439a-9e86-e6653d7627fc", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" }, { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book Modifier", "type": "text/plain" }, "type": "any", "value": "string", "key": "modifierID" } ] }, "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 \"data\": {\n \"id\": \"37f2eed6-0bea-4d0b-a3c6-24cc76143bfd\",\n \"type\": \"price-modifier\",\n \"attributes\": {\n \"currencies\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_5\": {\n \"minimum_quantity\": 5,\n \"amount\": 50\n }\n }\n },\n \"CAD\": {\n \"amount\": 127,\n \"includes_tax\": false,\n \"tiers\": {\n \"min_10\": {\n \"minimum_quantity\": 10,\n \"amount\": 100\n }\n }\n },\n \"GBP\": {\n \"amount\": 73,\n \"includes_tax\": true,\n \"tiers\": {\n \"min_20\": {\n \"minimum_quantity\": 20,\n \"amount\": 60\n }\n }\n }\n },\n \"name\": \"large-supplement\",\n \"modifier_type\": \"price_equals\",\n \"external_ref\": \"external-ref\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The modifier already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The modifier already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df21f93c-acc0-4d75-bf53-78df52dc9f6c", "name": "Delete a Modifier", "request": { "name": "Delete a Modifier", "description": { "content": "Deletes the specified price book modifier.", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "pricebookID", "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "modifierID", "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book Modifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "3ab3986a-ee7f-463e-898c-5899a2f80735", "name": "A 204 response indicates that the price modifiers have been deleted", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" }, { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book Modifier", "type": "text/plain" }, "type": "any", "value": "string", "key": "modifierID" } ] }, "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": "bb38a3db-649b-4943-b809-33d692dfdba7", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", ":pricebookID", "modifiers", ":modifierID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book", "type": "text/plain" }, "type": "any", "value": "string", "key": "pricebookID" }, { "disabled": false, "description": { "content": "(Required) Unique identifier of a Price Book Modifier", "type": "text/plain" }, "type": "any", "value": "string", "key": "modifierID" } ] }, "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The modifier already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The modifier already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Import a Price Book and Prices", "description": "You can create and update product price books and prices in bulk, at both organization and store level, using the Price Book Import API. This is useful, for example, if you have a promotion and want to update 50,000 product prices. Rather than having to go to each price book and manually edit 50,000 prices, you can use the Price Book Import API to bulk update all your product prices at the same time, including setting different prices for different currencies.\n\nYou can create/update:\n\n- price books.\n- prices.\n - sales pricing for products and product bundles with SKUs.\n - volume pricing (tiers).\n\nThe following are not supported by the Price Book Import API:\n\n- price modifiers\n- SKUless bundles\n- Bundle sale prices\n\nThe API uses a [JSONL](https://jsonlines.org/) file. The JSONL file can be compressed to a GZIP file. Here is an [example of a JSONL file](/assets/example_file_all.jsonl).\n\nA file can include up to 50,000 objects. If you have more than 50,000 objects, then you must create a separate file, and import each file, one at a time.\n\n### Characteristics of Price Book Import\n\nThe Price Book Import API reads the entire file and then creates/updates the price book objects. This means the price book objects can be in any order in the file.\n\nPrice book imports are asynchronous. When you send a request to the price book import API, it triggers an asynchronous job to create/update the price books and product prices. You can see the status of a job using Get a job.\n\nJobs are processed one at a time. You can continue to send price book import requests, but those jobs are queued. In other words, Commerce looks for any jobs that have a status of PENDING and starts the job with the earliest created date. This process is repeated until all jobs are processed. See [Jobs](/docs/api/pxm/products/jobs).\n\nThe API works on a \"best endeavours\" approach. In other words, the API does its best to create/update the price book objects based on the file that you provide. You can then use the results of the job to understand what objects the API created/updated and to troubleshoot any errors. See [Price Book Import API Results](#price-book-import-api-results).\n\nPrice book imports are processed sequentially in the order that you send your import API requests.\n\n### Price Book Import Unique Identifiers\n\nThe API uses unique identifiers to identify the objects to be created/updated.\n\nYou must provide either an `id` or an `external_ref`. You may have both, but you must have at least one.\n\n- If you supply an `id` then the ID must exist for the object to be updated. If the ID does not exist, this causes an error.\n- If you supply an `external_ref` then the API checks if the external reference exists and updates the object. If the external reference does not exist, the API creates a new object with the external reference you have specified.\n\n#### Price Book Unique Identifiers\n\nThe following table describes the unique identifiers you must provide, depending on whether you are creating or updating a price book.\n\n| Action | Unique Identifiers |\n| --- | --- |\n| Creating |
  • Unique price book name.
  • `external_ref` for the price book.
|\n| Updating |
  • `id` and/or `external_ref` for the price book.
|\n\n#### Price Unique Identifiers\n\nThe following table describes the unique identifiers you must provide, depending on whether you are creating or updating a price.\n\n | Action | Unique Identifiers |\n | --- | --- |\n | Creating |
  • The product SKU that the price belongs to.
  • `id` and/or `external_ref` for the price book where you want to create the new price.
  • `external_ref` for the price. The `external_ref` for a price must be unique within a price book. However, you can have duplicate price external references across multiple price books.
|\n | Updating |
  • The product SKU that the price belongs to.
  • `pricebook_external_ref` for the price book where you want to update the new price.
  • `id` and/or `external_ref` for the price. The `external_ref` for a price must be unique within a price book. However, you can have duplicate price external references across multiple price books.
|\n \n ### Price Book Import File\n \n You can create/update price book objects using [Import a Price](/docs/api/pxm/pricebooks/import-a-price-book-and-prices).\n \n The API uses a [JSONL](https://jsonlines.org/) file. The JSONL file can be compressed to a GZIP file. Here is an [example of a JSONL file](/assets/example_file_all.jsonl).\n \n A file can include up to 50,000 objects. If you have more than 50,000 objects, then you must create a separate file, and import each file, one at a time.\n \n - The `pricebook` Object - The attributes you can specify for a `pricebook` object are the attributes you specify when [creating a pricebook](/docs/api/pxm/pricebooks/create-pricebook). \n \n - The `product-price` Object - The attributes you can specify for a `product-price` object are the attributes you specify when [adding a price to a price book](/docs/api/pxm/pricebooks/create-product-price).\n \n Once your import file is created, use the [import a price book and prices API to import](/docs/api/pxm/pricebooks/import-pricebook) the file.\n \n ### Importing product prices with custom attributes\n \n There are two types of custom attributes a price can have `shopper_attributes` and `admin_attributes`. When importing product prices with custom attributes, you can import a price with:\n \n - up to 100 `admin_attributes`\n - up to 100 `shopper_attributes`\n \n Ensure that a price adheres to these limits for custom attributes.\n \n ### Price Book Import API Results\n \n The API works on a \"best endeavours\" approach. In other words, the API does its best to create/update the price book objects based on the file that you provide.\n \n If there are any errors, then the import is aborted and the job fails with an error. You can then use the job results to understand what objects the API created/updated until the import failed and to troubleshoot any errors. \n \n Once you have fixed any errors, you can then use the [**import a price**](/docs/api/pxm/pricebooks/import-pricebook) endpoint to send the request again.\n \n The following table describes the import messages reported by the API.\n \n | Import Message | Description |\n | --- | --- |\n |
  • import price book_id: '%v' belongs to Organization\", price book.ID))
  • \"import price book external_ref: '%v' belongs to Organization\", *price book.ExternalRef)
| This group of messages tells you that these imported objects belong to an organization. \n |
  • matched price with pricebook_id - had different external_ref
  • matched price with pricebook_id - belongs to different price book
  • matched price with pricebook_id - price_id not found
  • matched price with pricebook_id - price_id belongs to an organization.
  • matched price with pricebook_id - duplicate external_ref detected
  • matched price with pricebook_id - duplicate SKU detected - required SKU.
| This group of messages is telling you that the price was updated but there is an issue with another attribute that requires fixing. |\n \n The following table describes the import errors reported by the API.\n \n | Error | Description |\n | --- | --- |\n |
  • error processing gzip file
  • error processing object '%v' invalid json provided
| This group of errors indicates that there is a problem with the JSONL file. You must fix the problems with the file and try the import again. |\n |
  • duplicate price book Id '%s' in imported price books
  • missing attributes for price book
  • invalid type for external_ref for price book
  • missing attributes for price
  • missing sku for price
  • missing sku for price
  • invalid type for external_ref for price
  • invalid type for sku for price
  • missing price book_id/price book_external_ref for price
  • price book id(s) not found
  • price book external ref(s) not found
  • price book id not found:
  • duplicate external ref found
  • price Ids not found
  • price book external refs not found
| This group of errors indicates that there is some information missing from the objects you are trying to create/update. |\n", "item": [ { "id": "8c4fb9d9-15d0-46af-a9ca-d2892ca7c868", "name": "Import a Price", "request": { "name": "Import a Price", "description": { "content": "You can create and update product price books and prices in bulk, at both organization and store level, using the Price Book Import API. This is useful, for example, if you have a promotion and want to update 50,000 product prices. Rather than having to go to each price book and manually edit 50,000 prices, you can use the Price Book Import API to bulk update all your product prices at the same time, including setting different prices for different currencies.\n \n The API uses a [JSONL](https://jsonlines.org/) file. The JSONL file can be compressed to a GZIP file. Here is an [example of a JSONL file](/assets/example_file_all.jsonl).\n \n The API works on a \"best endeavours\" approach. In other words, the API does its best to create/update the price book objects based on the file that you provide. If there are any errors, then the import is aborted, and the job fails with an error. You can then use the job results to understand what objects the API created/updated until the import failed, and to troubleshoot any errors. See [Import Results](#tag/Price-Book-Import).\n \n Price book imports are processed sequentially in the order that you send your import API requests.\n", "type": "text/plain" }, "url": { "path": [ "pcm", "pricebooks", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "24bf5632-0456-4f71-bad1-2e4abac92a77", "name": "The created price book", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", "import" ], "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": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"0dd4e7de-006f-460f-a43e-a581f375cedc\",\n \"attributes\": {\n \"created_at\": \"2020-09-22T09:00:00Z\",\n \"updated_at\": \"2020-09-22T09:00:00Z\",\n \"type\": \"pricebook-import\",\n \"status\": \"pending\",\n \"started_at\": \"2020-09-22T09:00:00Z\",\n \"completed_at\": \"2020-09-22T09:00:00Z\"\n },\n \"meta\": {\n \"x_request_id\": \"2d70776e-c2b0-4446-84e6-d08a24edfca4\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "916af078-421e-4522-b1a7-84d1d4c57081", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "pcm", "pricebooks", "import" ], "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": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n },\n {\n \"detail\": \"The price book already exists\",\n \"status\": \"409\",\n \"title\": \"conflict\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Promotions Standard", "description": "", "item": [ { "id": "25b63378-f1a8-414c-8ab7-a718aceedb28", "name": "Get all Promotions", "request": { "name": "Get all Promotions", "description": { "content": "Returns all promotions.\n\n:::note\n\nYou can use pagination with this resource. For more information, see [pagination](/guides/Getting-Started/pagination).\n\n:::\n\n### Filtering\n\nThe following operators and attributes are available when filtering on this endpoint. See [Supported Filtering Characters](https://elasticpath.dev/guides/Getting-Started/filtering#supported-characters).\n\nUse `code` filter to search codes within promotions.\n\n| Attribute | Type | Operator | Example |\n|:-----|:---------|:---------|:----------------------------------------|\n| `code` | `string` | `eq` | `eq(code,some_code)` | \n\nFor filtering advanced promotion usages, pass the `EP-Public-Search-Type=cm_search` header. Advanced search filtering is only applicable when the promotion code is consumed and the promotion is not deleted.\n\n| Attribute | Type | Operator | Example |\n|:-----|:---------|:---------|:----------------------------------------|\n| `promo_id` | `string` | `eq`\t | `eq(promo_id, 69c63c9d-8ccf-44b1-8e98-1e7feebfb581)` |\n| `promo_name` |`string`\t | `eq`, `like`\t | `eq(promo_name,cart percent discount)` |\n| `promo_type` | `string`\t | `eq`\t | `eq(promo_type,fixed_discount)` |\n| `promo_status` | `string`\t | `eq`\t | `eq(promo_status,Running)` |\n| `promo_checkouts` | `string`\t | `eq`,`gt`, `ge`, `lt`, `le`\t | `eq(promo_checkouts,2)` |\n| `promo_skus_prod_ids` |\t`string`\t | `eq`, `like`\t | `eq(promo_skus_prod_ids, sku1)` |\n| `promo_start_date` |\t`string`\t| `eq`, `gt`, `gr`, `lt`, `le` | `eq(promo_start_date,2023-01-01)` |\n| `promo_end_date` |\t`string` | `eq`, `gt`, `gr`, `lt`, `le`\t | `eq(promo_end_date,2050-06-15)` |\n| `code_id`\t | `string` | `eq` | `eq(promo_id,2ea0cd1d-43a9-441b-b03f-3cab84aaee0c):eq(code_id,14b55e6c-3f80-436e-a90a-4de5f0e36240)` |\n| `code_code` | `string` | `eq`, `like` | \t`eq(code_code,cart_fixed_10)` |\n| `code_used`\t | `string` | `eq`, `gt`, `gr`, `lt`, `le`\t | `eq(code_used,2)` |\n| `code_created_date` |\t`string`\t| `eq`, `gt`, `gr`, `lt`, `le`\t | `eq(code_created_date,2023-11-15)` |\n| `order_id` |\t`string` | `eq`, `like`\t | `eq(order_id,ccb13673-627c-4976-88da-f77c542b528f)` |\n| `order_customer_email`\t | `string` | `eq`, `like`\t | `like(order_customer_email,andy*)` |\n| `order_created_date`\t | `string`\t| `eq`, `gt`, `gr`,`lt`, `le`\t | `le(order_created_date,2023-11-15)` | \n", "type": "text/plain" }, "url": { "path": [ "v2", "promotions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "89cb54ee-32e1-4b2f-b15f-e201b757f51a", "name": "200", "originalRequest": { "url": { "path": [ "v2", "promotions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "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 \"type\": \"string\",\n \"id\": \"d276def8-b3cf-9487-fe78-800f3327fad9\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": true,\n \"enabled\": false,\n \"promotion_type\": \"item_percent_discount\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 897,\n \"currency\": \"string\"\n },\n {\n \"amount\": 7514,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 2152.2596214429423\n },\n {\n \"type\": \"string\",\n \"id\": \"f1bbeb4a-9b71-e447-fade-1f94b693ee54\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"enabled\": false,\n \"promotion_type\": \"x_for_amount\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 4862,\n \"currency\": \"string\"\n },\n {\n \"amount\": 9768,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 6219.824955748186\n }\n ],\n \"links\": {\n \"current\": \"string\",\n \"first\": \"string\",\n \"last\": \"string\",\n \"next\": \"string\",\n \"prev\": \"string\"\n },\n \"meta\": {\n \"page\": {\n \"current\": 1777,\n \"limit\": 6498,\n \"offset\": 6410,\n \"total\": 2169\n },\n \"results\": {\n \"total\": 5526\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5277c596-02c9-4e59-bc86-baf1d3c0a2f5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "promotions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "10" } ], "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 {\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bcae674a-e17c-4065-b6b5-44e9cef63ea2", "name": "Create a Promotion", "request": { "name": "Create a Promotion", "description": { "content": "You can use this endpoint to create the following types of promotion:\n - Cart Fixed Discount Promotion\n - Cart Percent Discount Promotion\n - X for Y Discount Promotion\n - X for Amount Discount Promotion\n - Fixed Bundle Discount Promotion\n - Item Fixed Discount Promotion\n - Item Percent Discount Promotion\n - Free Gift Promotion\n\n### The `schema` object\n\nPromotions are defined by schemas that are used internally to verify promotions and calculate discounts. You must define a schema when you create the promotion. For more information, see the schema.exclude criteria and the targeting fields criteria.\n\n#### The `schema.exclude` criteria\n\nWhen creating a promotion, you can specify when it **should not** be applied. The promotion will not be applied on any cart (or cart item, depending on the promotion type) that fulfills at least one of the `schema.exclude` criteria. The following criteria can be set to exclude items from a promotion:\n\n- `schema.exclude.targets`\n- `schema.exclude.nodes`\n- `schema.exclude.attributes`\n- `schema.exclude.conditions`\n\nFor example, if you want to create a promotion with value as *SKU1* in `schema.exclude.targets` and and color *yellow* and size *small* in `schema.exclude.attributes`, then any products with *SKU1* or the color *yellow* or the size *small* will be excluded from the promotion.\n\nTo exclude products from a promotion based on multiple conditions at the same time, use `schema.exclude.conditions`. For example, use `schema.exclude.conditions` to exclude items that are both *yellow* in color and *small* in size.\n\n#### The targeting fields criteria\n\nWhen creating a promotion, you can also specify when it **should** be applied. To define the targeted products, use the following fields:\n\n - `schema.target_catalogs`\n - `schema.targets`\n - `schema.target_nodes`\n - `schema.target_attributes`\n - `schema.target_conditions`\n\nThe cart item's catalog is verified if you define the `schema.target_catalogs` field. If the item is in any of the targeted catalogs specified in `schema.target_catalogs`, the promotion will be applied. If the item is not in any of the catalogs, the promotion will not be applied.\n\nThen, the cart item is verified to see if it fulfills at least one criteria of any of the four other targeting fields. In other words, the `schema` targeting fields such as `schema.targets`, `schema.target_nodes`, `schema.target_attributes` and `schema.target_conditions` create *OR* targeting conditions.\n\nFor example, if you create a promotion with values as *SKU1* in `schema.targets` and color *yellow* and size *small* in `schema.target_attributes`, then it will be applied to any products with *SKU1* or the color *yellow* or the size *small*.\n\nTo create a promotion that targets products based on multiple conditions at the same time, use `schema.target_conditions`. For example, use it to target items that are both *yellow* in color and *small* in size.\n\n:::note\n\nFor Cart Fixed Discount Promotion and Cart Percent Discount Promotion, the cart item's catalog is verified if you define the `schema.target_catalogs` field. If the item is in any of the targeted catalogs specified in `schema.target_catalogs`, the promotion will be applied. If the item is not in any of the catalogs, the promotion will not be applied.\n\n:::\n\n:::caution\n\n- Line-item discounts are only supported by the line calculation method. For more information about this method, see the Calculation Method section.\n- Hierarchy-based promotions are not supported for fixed bundle discount promotion and free gift promotion. To promote a bundle, create the bundle in Product Experience Manager, and then create a promotion for that bundle. For more information, see Bundles in Product Experience Manager.\n- For Free Gift Promotion, we recommend using `auto_add_free_gift` feature with `automatic` setting enabled. When `automatic` is set to `true`, it indicates that promotions are added automatically, and discounts are applied accordingly. If you enable the `auto_add_free_gift`, but do not enable the `automatic` setting, gift items will be added without discounts. In this case, shoppers need to apply coupon codes twice, first to add the gift item and then to apply the discount.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "promotions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"enabled\": false,\n \"promotion_type\": \"bundle_gift\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 850,\n \"currency\": \"string\"\n },\n {\n \"amount\": 7411,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 9248.01841739747\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1c4f7994-5a9b-4bd1-8b65-50ba8e57ea15", "name": "201", "originalRequest": { "url": { "path": [ "v2", "promotions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"enabled\": false,\n \"promotion_type\": \"bundle_gift\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 850,\n \"currency\": \"string\"\n },\n {\n \"amount\": 7411,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 9248.01841739747\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"id\": \"89c05c8c-671f-a0d0-2ce4-2d66543b4763\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"enabled\": false,\n \"promotion_type\": \"fixed_discount\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 3869,\n \"currency\": \"string\"\n },\n {\n \"amount\": 1761,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 7220.261270415657\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "888f2472-f883-48ee-a50d-e8f8257b123c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "promotions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"enabled\": false,\n \"promotion_type\": \"bundle_gift\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 850,\n \"currency\": \"string\"\n },\n {\n \"amount\": 7411,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 9248.01841739747\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "418326df-3934-4668-9edc-960070b2663d", "name": "Get a Promotion", "request": { "name": "Get a Promotion", "description": { "content": "Retrieves a promotion.", "type": "text/plain" }, "url": { "path": [ "v2", "promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The ID of the promotion.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b0a3b3b0-239d-4a2a-8e7d-3572d4e8a706", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 \"type\": \"string\",\n \"id\": \"89c05c8c-671f-a0d0-2ce4-2d66543b4763\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"enabled\": false,\n \"promotion_type\": \"fixed_discount\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 3869,\n \"currency\": \"string\"\n },\n {\n \"amount\": 1761,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 7220.261270415657\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "330633d3-449e-4656-8884-8c08598b83e8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 {\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4309be2c-fa13-4de4-aac8-57add23054bc", "name": "Update a Promotion", "request": { "name": "Update a Promotion", "description": { "content": "Use this endpoint to update a specific promotion.\n\n:::note\n\n You can re-enable an expired promotion by updating the end date to a future date. However, when you enable a promotion again, all codes previously attached to it are deleted to make sure that duplicate promotion codes do not exist on different promotions.\n\n:::\n\n### Errors\n\nWhen extending the end date of an expired promotion with over 1000 codes, you will receive the following error response. In such cases, we recommend duplicating the promotion, allowing you to set the new end dates and create promotion codes as needed.\n\n```json\n{\n \"errors\": [\n {\n \"status\": 422,\n \"source\": \"request\",\n \"title\": \"Unprocessable Entity\",\n \"detail\": \"\"\n }\n ]\n}\n```\n", "type": "text/plain" }, "url": { "path": [ "v2", "promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique promotion identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"type\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": true,\n \"enabled\": false,\n \"promotion_type\": \"x_for_amount\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 7909,\n \"currency\": \"string\"\n },\n {\n \"amount\": 7021,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 7532.778014120511\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ced7d7ca-b4bd-45a4-8e8b-2dde6b827aef", "name": "200", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique promotion identifier.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 \"type\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": true,\n \"enabled\": false,\n \"promotion_type\": \"x_for_amount\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 7909,\n \"currency\": \"string\"\n },\n {\n \"amount\": 7021,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 7532.778014120511\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"id\": \"89c05c8c-671f-a0d0-2ce4-2d66543b4763\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"enabled\": false,\n \"promotion_type\": \"fixed_discount\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 3869,\n \"currency\": \"string\"\n },\n {\n \"amount\": 1761,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 7220.261270415657\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d20d893f-15e1-4fd1-824d-04198d699e78", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique promotion identifier.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 \"type\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": true,\n \"enabled\": false,\n \"promotion_type\": \"x_for_amount\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 7909,\n \"currency\": \"string\"\n },\n {\n \"amount\": 7021,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 7532.778014120511\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7128ef1f-57ec-4484-a084-926fa5f66a23", "name": "Delete a Promotion", "request": { "name": "Delete a Promotion", "description": { "content": "Use this endpoint to delete a specific promotion.", "type": "text/plain" }, "url": { "path": [ "v2", "promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The ID of the promotion that you want to delete.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "9f9ae6b3-8e64-4686-96e0-1498c5d55b4d", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the promotion that you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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": "4f33c8d7-758a-47da-8390-b45c9742181a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the promotion that you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 {\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9d60fc4-abb5-45cc-b146-4b54845f2aaa", "name": "Get a Promotion History", "request": { "name": "Get a Promotion History", "description": { "content": "Use this endpoint to retrieve a promotion history.", "type": "text/plain" }, "url": { "path": [ "v2", "promotions", ":promotionID", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The ID of the promotion.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "75a21696-c9a5-4c52-9c9a-012bd58e3a95", "name": "200", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 \"type\": \"string\",\n \"id\": \"d276def8-b3cf-9487-fe78-800f3327fad9\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": true,\n \"enabled\": false,\n \"promotion_type\": \"item_percent_discount\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 897,\n \"currency\": \"string\"\n },\n {\n \"amount\": 7514,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 2152.2596214429423\n },\n {\n \"type\": \"string\",\n \"id\": \"f1bbeb4a-9b71-e447-fade-1f94b693ee54\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"enabled\": false,\n \"promotion_type\": \"x_for_amount\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 4862,\n \"currency\": \"string\"\n },\n {\n \"amount\": 9768,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 6219.824955748186\n }\n ],\n \"links\": {\n \"current\": \"string\",\n \"first\": \"string\",\n \"last\": \"string\",\n \"next\": \"string\",\n \"prev\": \"string\"\n },\n \"meta\": {\n \"page\": {\n \"current\": 1777,\n \"limit\": 6498,\n \"offset\": 6410,\n \"total\": 2169\n },\n \"results\": {\n \"total\": 5526\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b2be7dc-bdd8-426f-b5b6-7e122dc4d5c4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 {\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Promotion Codes", "description": "You can apply promotions automatically to all customer carts, or you can create promotion codes that customers must enter to receive the discount. You can enable this feature by setting the automatic attribute to `false` in the promotions schema when you create a promotion. For more information, see [Create Promotion Codes](/docs/api/promotions/create-promotion-codes).\n\nYou can generate and export codes for a promotion using the bulk code generation feature, which allows you to create a large number of unique codes and export them in CSV format. For details, refer to the [Generating Bulk Codes](/docs/commerce-manager/promotions-standard/overview#generating-bulk-codes) and [Managing Export Codes](/docs/commerce-manager/promotions-standard/overview#managing-code-export) sections.\n\nYou can generate a maximum of 1000 codes for a promotion. If you need to generate more than 1000 codes, limit the promotion's duration to a maximum of 365 days from its start date. The promotion expiry date is 365 days.\n\nWith the consume unit feature, you can limit the number of usages of a code for a promotion. You must create a code for this promotion to track the usage of the promotion. The consume unit options are `per_cart` and `per_item`. For example, consider a store that offers 50% off on *SKU1*, but limits the promotion to a maximum of two usages. Under the `per_cart` setting, a shopper can buy *SKU1* twice in a separate transaction, each at a 50% discount. However, with the `per_item` setting, if a shopper buys two SKU1s in a single purchase, both items count toward the promotion's usage limit. Therefore, the shopper would use up both usages of the promotion in a single purchase.\n\nPromotion codes can be group codes or individual codes. For example, you can offer a seasonal discount to all customers, such as *SUMMER-SALE*, or you can offer preferred customers unique discount codes. Promotion codes expire automatically at the end of the promotion period and are removed from the promotion.\n\nWhen a promotion expires, the promotion codes attached to the promotion automatically become invalid. However, when you re-enable the expired promotion, the promotion codes attached to the promotion are deleted.\n\nWhen you checkout a cart with an expired promotion, the expired promotion will be automatically removed from a cart and the checkout process is initiated. As a best practice, we recommend to update your cart to remove the expired promotion before initiating the checkout process.\n\nWhen extending the end date of an expired promotion with over 1000 codes, you will receive an error response. See [Update a Promotion](/docs/api/promotions/update-a-promotion). In such cases, we recommend [duplicating the promotion](/docs/commerce-manager/promotions-standard/overview#duplicating-promotions), allowing you to set the new end dates and create promotion codes as needed.\n", "item": [ { "id": "3ab6fead-2d8e-409f-a2d1-419e82299b99", "name": "Get Promotion Codes", "request": { "name": "Get Promotion Codes", "description": { "content": "You can use this endpoint to retrieve promotion codes. \n\n:::note\n- The `codes.max_uses` attribute represents the maximum usage of the codes. \n- The `codes.uses` attribute represents the remaining number of times the codes can be used for the promotion.\n- Codes created before April 27, 2023 will only have `codes.uses` attribute in the response body.\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This parameter accepts a filtering expression that uses specific operators and attributes. Promotion codes are case-insensitive.\n\nThe following operators and attributes are available when filtering on this endpoint. See [Supported Filtering Characters](/guides/Getting-Started/filtering#supported-characters).\n\n| Attribute | Type | Operator | Example |\n|:--------- |:---------|:------------|:---------------|\n| `code` | `string`, `number` | `eq`, `gt` | `eq(code,summer2024)`, `gt(code,2024)` |\n", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the promotion.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "81b570fd-eddd-4253-986d-644c200052eb", "name": "200", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This parameter accepts a filtering expression that uses specific operators and attributes. Promotion codes are case-insensitive.\n\nThe following operators and attributes are available when filtering on this endpoint. See [Supported Filtering Characters](/guides/Getting-Started/filtering#supported-characters).\n\n| Attribute | Type | Operator | Example |\n|:--------- |:---------|:------------|:---------------|\n| `code` | `string`, `number` | `eq`, `gt` | `eq(code,summer2024)`, `gt(code,2024)` |\n", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 \"data\": {\n \"codes\": [\n {\n \"code\": \"string\",\n \"consume_unit\": \"string\",\n \"user\": \"string\",\n \"uses\": 7118.543121156309,\n \"created_by\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-11-07T23:04:18.845Z\"\n }\n }\n },\n {\n \"code\": \"string\",\n \"consume_unit\": \"string\",\n \"user\": \"string\",\n \"uses\": 5499.06108477481,\n \"created_by\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-11-07T23:04:18.845Z\"\n }\n }\n }\n ]\n }\n },\n {\n \"data\": {\n \"codes\": [\n {\n \"code\": \"string\",\n \"consume_unit\": \"string\",\n \"user\": \"string\",\n \"uses\": 5744.614349516537,\n \"created_by\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-11-07T23:04:18.845Z\"\n }\n }\n },\n {\n \"code\": \"string\",\n \"consume_unit\": \"string\",\n \"user\": \"string\",\n \"uses\": 4688.733196727948,\n \"created_by\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-11-07T23:04:18.845Z\"\n }\n }\n }\n ]\n }\n }\n ],\n \"links\": {\n \"current\": \"string\",\n \"first\": \"string\",\n \"last\": \"string\",\n \"next\": \"string\",\n \"prev\": \"string\"\n },\n \"meta\": {\n \"page\": {\n \"current\": 8912,\n \"limit\": 1635,\n \"offset\": 7053,\n \"total\": 8458\n },\n \"results\": {\n \"total\": 849\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49825054-4254-4a63-b624-89e01cf61e03", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This parameter accepts a filtering expression that uses specific operators and attributes. Promotion codes are case-insensitive.\n\nThe following operators and attributes are available when filtering on this endpoint. See [Supported Filtering Characters](/guides/Getting-Started/filtering#supported-characters).\n\n| Attribute | Type | Operator | Example |\n|:--------- |:---------|:------------|:---------------|\n| `code` | `string`, `number` | `eq`, `gt` | `eq(code,summer2024)`, `gt(code,2024)` |\n", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 {\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1cd1600-0595-45fd-8db5-6a574b3cc371", "name": "Create Promotion Codes", "request": { "name": "Create Promotion Codes", "description": { "content": "Use this endpoint to create promotion codes for a specific promotion.\n\n:::note\n\nWhen a promotion expires, the promotion codes attached to the promotion automatically become invalid. However, when you re-enable the expired promotion, the promotion codes attached to the promotion are deleted.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the promotion.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"codes\": [\n {\n \"code\": \"string\",\n \"consume_unit\": \"string\",\n \"user\": \"string\",\n \"uses\": 1347.28398067681\n },\n {\n \"code\": \"string\",\n \"consume_unit\": \"string\",\n \"user\": \"string\",\n \"uses\": 110.18008004479051\n }\n ],\n \"type\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e55324f1-91de-4cc8-ad5e-47178781f632", "name": "201", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"codes\": [\n {\n \"code\": \"string\",\n \"consume_unit\": \"string\",\n \"user\": \"string\",\n \"uses\": 1347.28398067681\n },\n {\n \"code\": \"string\",\n \"consume_unit\": \"string\",\n \"user\": \"string\",\n \"uses\": 110.18008004479051\n }\n ],\n \"type\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"id\": \"89c05c8c-671f-a0d0-2ce4-2d66543b4763\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"automatic\": false,\n \"enabled\": false,\n \"promotion_type\": \"fixed_discount\",\n \"schema\": {\n \"currencies\": [\n {\n \"amount\": 3869,\n \"currency\": \"string\"\n },\n {\n \"amount\": 1761,\n \"currency\": \"string\"\n }\n ],\n \"target_catalogs\": [\n \"string\",\n \"string\"\n ],\n \"conditions\": {\n \"or\": [\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n },\n {\n \"and\": [\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n },\n {\n \"attribute\": {\n \"template\": \"string\",\n \"field\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\"\n }\n }\n ]\n }\n ]\n }\n },\n \"start\": \"string\",\n \"end\": \"string\",\n \"min_cart_value\": {},\n \"max_applications_per_cart\": 7220.261270415657\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ad4b0db-028f-4f64-9204-bed5d2935087", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"codes\": [\n {\n \"code\": \"string\",\n \"consume_unit\": \"string\",\n \"user\": \"string\",\n \"uses\": 1347.28398067681\n },\n {\n \"code\": \"string\",\n \"consume_unit\": \"string\",\n \"user\": \"string\",\n \"uses\": 110.18008004479051\n }\n ],\n \"type\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "387de51d-5188-4c2a-a1f4-6014e5c387f1", "name": "Delete Multiple Promotion Codes", "request": { "name": "Delete Multiple Promotion Codes", "description": { "content": "Use this endpoint to delete multiple promotion codes within a specific promotion.", "type": "text/plain" }, "url": { "path": [ "v2", "promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The ID of the promotion associated with the codes.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "baf15310-ac96-4f89-a6ab-c40e934c7e2a", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the promotion associated with the codes.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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": "13312123-5c9a-4ebe-b541-6f631441982e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the promotion associated with the codes.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 {\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad80f082-fd1d-48e8-aaf9-1fdd807afe45", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the promotion associated with the codes.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 {\n \"errors\": [\n {\n \"detail\": \"promotion not found\",\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75b545ac-2a51-454a-8e98-6f1c6113de36", "name": "Delete a Promotion Code", "request": { "name": "Delete a Promotion Code", "description": { "content": "Use this endpoint to delete a single promotion code.", "type": "text/plain" }, "url": { "path": [ "v2", "promotions", ":promotionID", "codes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) Specifies the unique identifier of the promotion associated with the codes.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "code", "disabled": false, "description": { "content": "(Required) Specifies the code that you want to delete.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "50595b6d-5e09-41d7-aa07-12df817e421c", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "codes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the unique identifier of the promotion associated with the codes.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" }, { "disabled": false, "description": { "content": "(Required) Specifies the code that you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "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": "07922629-59a0-4ac5-9f2b-872e8cd34b86", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "codes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the unique identifier of the promotion associated with the codes.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" }, { "disabled": false, "description": { "content": "(Required) Specifies the code that you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "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 {\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f782a05a-3125-4899-a169-36cb40494bfb", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "codes", ":code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Specifies the unique identifier of the promotion associated with the codes.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" }, { "disabled": false, "description": { "content": "(Required) Specifies the code that you want to delete.", "type": "text/plain" }, "type": "any", "value": "string", "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 {\n \"errors\": [\n {\n \"detail\": \"promotion not found\",\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Promotion Jobs", "description": "Use Jobs API to initiate a job within a promotion. Jobs operate asynchronously and have a different status based on their progress. The following are the job statuses:\n\n- `pending`: Commerce has received the request but is currently busy processing other requests.\n- `processing`: Commerce has initiated processing the job.\n- `completed`: The job is successfully completed.\n- `failed`: The job has failed.\n- `cancelling`: The job is currently in the process of being canceled. You need to wait for the cancellation process to complete. This occurs prior to the `cancelled` status. For example, if you cancel a big `code_generate` job, it may take some time for the cancellation to complete since part of the cancellation process involves deleting the generated codes.\n- `cancelled` : The job request is canceled.\n\n![Promotion Job Statuses Workflow](/assets/job_status_workflow.png)\n\n### Characteristics of Jobs\n\n- You can only initiate one job at a time within a promotion. If you want to run another job for the same promotion, you must wait until the previous job is `completed` or `failed`. However, you can create new jobs for different promotions even if there are `pending` jobs in other promotions.\n- If you intend to manage promotions with more than 10,000 codes per promotion, we recommend [exporting codes](/docs/api/promotions/create-a-promotion-job) for viewing purposes instead of attempting to view them within Commerce Manager. This recommendation is made due to our enforced maximum page offset limit of 10,000. Altering the page_offset_limit value poses potential performance risks to the platform.\n- A `code_generate` job is initiated even if the maximum allowable number of codes for the promotion has been reached. However, when processed, this job will fail. To view the status of this failed job, you can only do so by passing [GET Jobs](/docs/api/promotions/get-promotion-jobs) request.\n- A limited number of jobs can be processed at a time. Jobs are queued and processed sequentially, one after the other. You can expect a certain delay before job processing.\n", "item": [ { "id": "c1ab169c-9dde-4e6f-ac80-050f54560b07", "name": "Get Promotion Jobs", "request": { "name": "Get Promotion Jobs", "description": { "content": "Retrieves the list of jobs for a specific promotion.\n\nIn the response example, you can see the `result.generated` field, which indicates the number of codes generated during the job processing. Additionally, you may also see the optional `result.deleted` field, indicating the number of codes deleted during the job cancellation. The parameters and result objects are shown only when `job_type` is `code_generate`.\n\n### Filtering\n\nThe following operators and attributes are available when filtering on this endpoint.\n\n| Attribute | Type | Operator | Example |\n| ----------| ----- | -------- | ------ |\n| `job_type` | `string` | `eq` | `eq(job_type, code_export)` |\n| `status` | `string` | `eq` | `eq(status, complete)` |\n\n### Errors\n\nIf an error occurs during job processing, the response includes an optional error field. For example, when you `GET` promotion jobs, the following response shows the details within the error field if an error occurred during job processing.\n\n ```json\n{\n \"data\": [\n {\n \"type\": \"promotion_job\",\n \"id\": \"84d86114-a92d-4c34-92f1-3e36ef6cabeb\",\n \"promotion_id\": \"ad386702-e780-42c6-b190-0527ad768917\",\n \"job_type\": \"code_generate\",\n \"name\": \"job\",\n \"parameters\": {\n \"number_of_codes\": 1000,\n \"consume_unit\": \"per_cart\",\n \"max_uses_per_code\": 1,\n \"code_length\": 8,\n \"code_prefix\": \"promo-\"\n },\n \"status\": \"failed\",\n \"error\": \"codes limit exceeded\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2023-12-06T13:52:29.587Z\",\n \"updated_at\": \"2023-12-06T13:54:49.133Z\"\n }\n }\n }\n ],\n \"links\": {\n \"current\": \"https://useast.api.elasticpath.com/v2/promotions/ad386702-e780-42c6-b190-0527ad768917/jobs?page[offset]=0&page[limit]=25\",\n \"first\": \"https://useast.api.elasticpath.com/v2/promotions/ad386702-e780-42c6-b190-0527ad768917/jobs?page[offset]=0&page[limit]=25\",\n \"last\": \"https://useast.api.elasticpath.com/v2/promotions/ad386702-e780-42c6-b190-0527ad768917/jobs?page[offset]=0&page[limit]=25\",\n \"prev\": \"https://useast.api.elasticpath.com/v2/promotions/ad386702-e780-42c6-b190-0527ad768917/jobs?page[offset]=0&page[limit]=25\",\n \"next\": \"https://useast.api.elasticpath.com/v2/promotions/ad386702-e780-42c6-b190-0527ad768917/jobs?page[offset]=0&page[limit]=25\"\n },\n \"meta\": {\n \"page\": {\n \"limit\": 25,\n \"offset\": 0,\n \"current\": 1,\n \"total\": 1\n },\n \"results\": {\n \"total\": 1\n }\n }\n}\n```\n", "type": "text/plain" }, "url": { "path": [ "v2", "promotions", ":promotionID", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of a promotion.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "412850bb-de27-43f2-a13f-fc535e90c83f", "name": "Successful response", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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\": \"string\",\n \"type\": \"promotion_job\",\n \"promotion_id\": \"string\",\n \"job_type\": \"string\",\n \"name\": \"string\",\n \"parameters\": {},\n \"status\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2017-09-15T08:23:37.829Z\",\n \"updated_at\": \"1963-11-14T12:10:57.140Z\"\n }\n }\n },\n {\n \"id\": \"string\",\n \"type\": \"promotion_job\",\n \"promotion_id\": \"string\",\n \"job_type\": \"string\",\n \"name\": \"string\",\n \"parameters\": {},\n \"status\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2020-11-26T13:45:32.908Z\",\n \"updated_at\": \"2009-10-27T01:41:22.800Z\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4e23c4e-a991-45df-9aba-ed2ab561f8fd", "name": "Create a Promotion Job", "request": { "name": "Create a Promotion Job", "description": { "content": "Use this endpoint to create an asynchronous job to generate codes and export promotion codes.", "type": "text/plain" }, "url": { "path": [ "v2", "promotions", ":promotionID", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of a promotion.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"promotion_job\",\n \"job_type\": \"code_generate\",\n \"name\": \"Summer Sale Job\",\n \"parameters\": {\n \"number_of_codes\": 1,\n \"max_uses_per_code\": 1,\n \"consume_unit\": \"per_cart\",\n \"code_prefix\": \"Summer-\",\n \"code_length\": 10\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d7791ed5-4129-4d32-8031-f6d5dbddd8bc", "name": "Promotion job created", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"promotion_job\",\n \"job_type\": \"code_generate\",\n \"name\": \"Summer Sale Job\",\n \"parameters\": {\n \"number_of_codes\": 1,\n \"max_uses_per_code\": 1,\n \"consume_unit\": \"per_cart\",\n \"code_prefix\": \"Summer-\",\n \"code_length\": 10\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"string\",\n \"type\": \"promotion_job\",\n \"promotion_id\": \"string\",\n \"job_type\": \"string\",\n \"name\": \"string\",\n \"parameters\": {},\n \"status\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"1962-10-20T01:02:03.909Z\",\n \"updated_at\": \"1954-09-13T05:06:45.581Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c849bd78-1379-406c-bb65-7a230b312298", "name": "Cancel a Job", "request": { "name": "Cancel a Job", "description": { "content": "Cancels an asynchronous job whose status is pending or processing.", "type": "text/plain" }, "url": { "path": [ "v2", "promotions", ":promotionID", "jobs", ":jobID", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of a promotion.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "jobID", "disabled": false, "description": { "content": "(Required) The unique identifier of a job to be canceled.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7e82fa46-9a56-4f18-b771-6f70a3aa8293", "name": "Job canceled successfully", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "jobs", ":jobID", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a job to be canceled.", "type": "text/plain" }, "type": "any", "value": "string", "key": "jobID" } ] }, "header": [ { "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": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"string\",\n \"type\": \"promotion_job\",\n \"promotion_id\": \"string\",\n \"job_type\": \"string\",\n \"name\": \"string\",\n \"parameters\": {},\n \"status\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"1962-10-20T01:02:03.909Z\",\n \"updated_at\": \"1954-09-13T05:06:45.581Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "020990cb-e0ee-459c-80a9-ae173f1c4fbf", "name": "Get Promotion Code Exported File", "request": { "name": "Get Promotion Code Exported File", "description": { "content": "Retrieves exported codes in a CSV format.", "type": "text/plain" }, "url": { "path": [ "v2", "promotions", ":promotionID", "jobs", ":jobID", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of a promotion.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "jobID", "disabled": false, "description": { "content": "(Required) The unique identifier of a job associated with the file.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "227d0d91-7cdc-460d-a5ef-ea96b2c26957", "name": "Successful response", "originalRequest": { "url": { "path": [ "v2", "promotions", ":promotionID", "jobs", ":jobID", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of a job associated with the file.", "type": "text/plain" }, "type": "any", "value": "string", "key": "jobID" } ] }, "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 \"href\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Rule Promotions", "description": "", "item": [ { "id": "86387731-7220-42c9-aa78-5e987d70f12e", "name": "Create a Rule Promotion", "request": { "name": "Create a Rule Promotion", "description": { "content": "Creates a new rule-based promotion, allowing flexible discount strategies based on cart or item conditions. \nPromotions can apply fixed or percentage-based discounts, apply automatically or via codes, and have eligibility rules \nbased on product attributes, cart total, SKU conditions, custom attributes, and more.\n\nThis endpoint supports a variety of promotion types, such as:\n- **Cart-wide discounts**\n- **Item-specific discounts**\n- **Shipping discounts**\n- **Combinations thereof**\n\n:::note\n\nThe minimum item discount amount is zero, both for amounts and percentages.\n\nA store can have a maximum of **50 active and future automatic rule promotions**.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"rule_promotion\",\n \"name\": \"Cart 20% discount when total is at least $100\",\n \"description\": \"20% discount applying to the cart total\",\n \"enabled\": false,\n \"automatic\": false,\n \"start\": \"2024-01-01\",\n \"end\": \"2025-01-01\",\n \"rule_set\": {\n \"rules\": {\n \"strategy\": \"cart_total\",\n \"operator\": \"gte\",\n \"args\": [\n 10000\n ]\n },\n \"actions\": [\n {\n \"strategy\": \"cart_discount\",\n \"args\": [\n \"percent\",\n 20\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f8cf2b9a-3ecd-4ac0-9d58-8bfd8c83425f", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "rule-promotions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"rule_promotion\",\n \"name\": \"Cart 20% discount when total is at least $100\",\n \"description\": \"20% discount applying to the cart total\",\n \"enabled\": false,\n \"automatic\": false,\n \"start\": \"2024-01-01\",\n \"end\": \"2025-01-01\",\n \"rule_set\": {\n \"rules\": {\n \"strategy\": \"cart_total\",\n \"operator\": \"gte\",\n \"args\": [\n 10000\n ]\n },\n \"actions\": [\n {\n \"strategy\": \"cart_discount\",\n \"args\": [\n \"percent\",\n 20\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99bd4877-babf-4217-9d66-f1bf0aa18933", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "rule-promotions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"rule_promotion\",\n \"name\": \"Cart 20% discount when total is at least $100\",\n \"description\": \"20% discount applying to the cart total\",\n \"enabled\": false,\n \"automatic\": false,\n \"start\": \"2024-01-01\",\n \"end\": \"2025-01-01\",\n \"rule_set\": {\n \"rules\": {\n \"strategy\": \"cart_total\",\n \"operator\": \"gte\",\n \"args\": [\n 10000\n ]\n },\n \"actions\": [\n {\n \"strategy\": \"cart_discount\",\n \"args\": [\n \"percent\",\n 20\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"400\",\n \"title\": \"Too many automatic rule promotions\",\n \"detail\": \"Only 50 active automatic rule promotions are allowed per store\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13803a15-7820-44fe-9a2d-ee8b729ad86b", "name": "Duplicate Priority", "originalRequest": { "url": { "path": [ "v2", "rule-promotions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"rule_promotion\",\n \"name\": \"Cart 20% discount when total is at least $100\",\n \"description\": \"20% discount applying to the cart total\",\n \"enabled\": false,\n \"automatic\": false,\n \"start\": \"2024-01-01\",\n \"end\": \"2025-01-01\",\n \"rule_set\": {\n \"rules\": {\n \"strategy\": \"cart_total\",\n \"operator\": \"gte\",\n \"args\": [\n 10000\n ]\n },\n \"actions\": [\n {\n \"strategy\": \"cart_discount\",\n \"args\": [\n \"percent\",\n 20\n ]\n }\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 \"errors\": [\n {\n \"status\": 9901,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"usage_ids\": [\n \"string\",\n \"string\"\n ]\n }\n },\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"usage_ids\": [\n \"string\",\n \"string\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df176501-e542-4ea4-a710-ef80b9f2b579", "name": "Get Rule Promotions", "request": { "name": "Get Rule Promotions", "description": { "content": "Retrieves a list of rule-based promotions, including information such as discount type, eligibility criteria, \nand configuration details. This endpoint supports filtering to refine results based on specific promotion attributes.\n\nUse query parameters to filter promotions by:\n- **Code** – Retrieve a specific promotion by its code.\n- **Promotion name** – Search for promotions by name.\n- **Activation status** – Filter by whether a promotion is active or not.\n- **Stackability** – Identify promotions that can or cannot be combined with others.\n- **Start and end dates** – Retrieve promotions based on their validity periods.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "This parameter accepts a filtering expression that uses specific operators and attributes. \n\n\nThe following operators and attributes are available when filtering on this endpoint. See [Supported Filtering Characters](/guides/Getting-Started/filtering#supported-characters).\n\n| Attribute | Type | Operator | Example |\n|:--------------------------|:-------------------|:-----------------------------|:----------------------------------------------------------------------|\n| `code` | `string`, `number` | `eq` | `eq(code,summer2024)` |\n| `name` | `string` | `like`,`ilike` | `ilike(name,'Summer *')` |\n| `enabled` | `boolean` | `eq` | `eq(enabled, true)` |\n| `stackable` | `boolean` | `eq` | `eq(stackable, true)` |\n| `override_stacking` | `boolean` | `eq` | `eq(override_stacking, true)` |\n| `start` | `date` | `lt`, `le`, `eq`, `gt`, `ge` | `gt(start, 2025-01-01T00:00:00.000Z)` |\n| `end` | `date` | `lt`, `le`, `eq`, `gt`, `ge` | `lt(end, 2025-01-01T00:00:00.000Z)` |\n| `rule_set.rules.strategy` | `string` | `eq`, `in` | `eq(rule_set.rules.strategy,account_tags)` |\n| `rule_set.rules.args` | `string` | `contains` | `contains(rule_set.rules.args, 11111111-1111-4111-1111-111111111111)` |\n| `account_tags` | `string` | `contains` | `contains(account_tags, 11111111-1111-4111-1111-111111111111)` |\n\nSome notes about filters:\n1. The `code` filter is case-insensitive. You can search for codes using only `numbers` or codes containing both `string` and `numbers`.\n2. The `rule_set.rules.*` filters do not search child conditions at present \n3. The `account_tags` filter will essentially search for any rule or child rule that has an `account_tags` strategy and the associated accounts.\n", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b32e9745-0a12-4612-8a2a-9f7d591fea9b", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "rule-promotions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "This parameter accepts a filtering expression that uses specific operators and attributes. \n\n\nThe following operators and attributes are available when filtering on this endpoint. See [Supported Filtering Characters](/guides/Getting-Started/filtering#supported-characters).\n\n| Attribute | Type | Operator | Example |\n|:--------------------------|:-------------------|:-----------------------------|:----------------------------------------------------------------------|\n| `code` | `string`, `number` | `eq` | `eq(code,summer2024)` |\n| `name` | `string` | `like`,`ilike` | `ilike(name,'Summer *')` |\n| `enabled` | `boolean` | `eq` | `eq(enabled, true)` |\n| `stackable` | `boolean` | `eq` | `eq(stackable, true)` |\n| `override_stacking` | `boolean` | `eq` | `eq(override_stacking, true)` |\n| `start` | `date` | `lt`, `le`, `eq`, `gt`, `ge` | `gt(start, 2025-01-01T00:00:00.000Z)` |\n| `end` | `date` | `lt`, `le`, `eq`, `gt`, `ge` | `lt(end, 2025-01-01T00:00:00.000Z)` |\n| `rule_set.rules.strategy` | `string` | `eq`, `in` | `eq(rule_set.rules.strategy,account_tags)` |\n| `rule_set.rules.args` | `string` | `contains` | `contains(rule_set.rules.args, 11111111-1111-4111-1111-111111111111)` |\n| `account_tags` | `string` | `contains` | `contains(account_tags, 11111111-1111-4111-1111-111111111111)` |\n\nSome notes about filters:\n1. The `code` filter is case-insensitive. You can search for codes using only `numbers` or codes containing both `string` and `numbers`.\n2. The `rule_set.rules.*` filters do not search child conditions at present \n3. The `account_tags` filter will essentially search for any rule or child rule that has an `account_tags` strategy and the associated accounts.\n", "type": "text/plain" }, "key": "filter", "value": "string" } ], "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": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c907214-fe0e-42e4-885d-05e0b7abbe32", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "rule-promotions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "This parameter accepts a filtering expression that uses specific operators and attributes. \n\n\nThe following operators and attributes are available when filtering on this endpoint. See [Supported Filtering Characters](/guides/Getting-Started/filtering#supported-characters).\n\n| Attribute | Type | Operator | Example |\n|:--------------------------|:-------------------|:-----------------------------|:----------------------------------------------------------------------|\n| `code` | `string`, `number` | `eq` | `eq(code,summer2024)` |\n| `name` | `string` | `like`,`ilike` | `ilike(name,'Summer *')` |\n| `enabled` | `boolean` | `eq` | `eq(enabled, true)` |\n| `stackable` | `boolean` | `eq` | `eq(stackable, true)` |\n| `override_stacking` | `boolean` | `eq` | `eq(override_stacking, true)` |\n| `start` | `date` | `lt`, `le`, `eq`, `gt`, `ge` | `gt(start, 2025-01-01T00:00:00.000Z)` |\n| `end` | `date` | `lt`, `le`, `eq`, `gt`, `ge` | `lt(end, 2025-01-01T00:00:00.000Z)` |\n| `rule_set.rules.strategy` | `string` | `eq`, `in` | `eq(rule_set.rules.strategy,account_tags)` |\n| `rule_set.rules.args` | `string` | `contains` | `contains(rule_set.rules.args, 11111111-1111-4111-1111-111111111111)` |\n| `account_tags` | `string` | `contains` | `contains(account_tags, 11111111-1111-4111-1111-111111111111)` |\n\nSome notes about filters:\n1. The `code` filter is case-insensitive. You can search for codes using only `numbers` or codes containing both `string` and `numbers`.\n2. The `rule_set.rules.*` filters do not search child conditions at present \n3. The `account_tags` filter will essentially search for any rule or child rule that has an `account_tags` strategy and the associated accounts.\n", "type": "text/plain" }, "key": "filter", "value": "string" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 9901,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"usage_ids\": [\n \"string\",\n \"string\"\n ]\n }\n },\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"usage_ids\": [\n \"string\",\n \"string\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b39597cd-883d-4c5d-bd8f-f170f70916bc", "name": "Get a Rule Promotion by ID", "request": { "name": "Get a Rule Promotion by ID", "description": { "content": "Retrieves a single Rule Promotion by the promotion ID. Responses include promotion specifications such as discount type, eligibility criteria, and configuration details.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ca92f0c9-8577-4acf-8703-1b8a95d72c4d", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1404fa2e-caff-41a9-b29c-84f7fc7480a3", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 \"errors\": [\n {\n \"status\": 9901,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"usage_ids\": [\n \"string\",\n \"string\"\n ]\n }\n },\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"usage_ids\": [\n \"string\",\n \"string\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9148dc77-9599-4476-806d-ad349b107158", "name": "Update a Rule Promotion", "request": { "name": "Update a Rule Promotion", "description": { "content": "Updates an existing Rule Promotion specified by its promotion ID. This includes both **semantic and syntactic validation** to ensure correctness. For example, the start date must be earlier than the end date.\n\nEditable fields include:\n- `name`\n- `description`\n- `enabled`\n- `start`\n- `end`\n- `automatic`\n- `stackable`\n- `override_stacking`\n- `rule_set`\n\n:::note\n\nWhen updating the `automatic` field from `false` to `true`, the store must not exceed the maximum limit of **50 active and future automatic rule promotions**.\n\n:::\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the promotion to be updated.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"rule_promotion\",\n \"name\": \"$10 off cart rule - updated\",\n \"description\": \"updated cart rule $10 off your order!\",\n \"enabled\": false,\n \"automatic\": false,\n \"rule_set\": {\n \"rules\": [\n {\n \"strategy\": \"cart_total\",\n \"operator\": \"lt\",\n \"args\": [\n 1000\n ]\n }\n ],\n \"actions\": [\n {\n \"strategy\": \"cart_discount\",\n \"args\": [\n \"percent\",\n 10\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "297eae75-46ca-47ca-9111-f3246e727072", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the promotion to be updated.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 \"data\": {\n \"type\": \"rule_promotion\",\n \"name\": \"$10 off cart rule - updated\",\n \"description\": \"updated cart rule $10 off your order!\",\n \"enabled\": false,\n \"automatic\": false,\n \"rule_set\": {\n \"rules\": [\n {\n \"strategy\": \"cart_total\",\n \"operator\": \"lt\",\n \"args\": [\n 1000\n ]\n }\n ],\n \"actions\": [\n {\n \"strategy\": \"cart_discount\",\n \"args\": [\n \"percent\",\n 10\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46606663-6fb7-43be-bd85-3400a21de11c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the promotion to be updated.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 \"data\": {\n \"type\": \"rule_promotion\",\n \"name\": \"$10 off cart rule - updated\",\n \"description\": \"updated cart rule $10 off your order!\",\n \"enabled\": false,\n \"automatic\": false,\n \"rule_set\": {\n \"rules\": [\n {\n \"strategy\": \"cart_total\",\n \"operator\": \"lt\",\n \"args\": [\n 1000\n ]\n }\n ],\n \"actions\": [\n {\n \"strategy\": \"cart_discount\",\n \"args\": [\n \"percent\",\n 10\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"400\",\n \"title\": \"Too many automatic rule promotions\",\n \"detail\": \"Only 50 active and future automatic rule promotions are allowed per store\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fc88363-b1ab-49e5-b79e-5c52faed949f", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the promotion to be updated.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 \"data\": {\n \"type\": \"rule_promotion\",\n \"name\": \"$10 off cart rule - updated\",\n \"description\": \"updated cart rule $10 off your order!\",\n \"enabled\": false,\n \"automatic\": false,\n \"rule_set\": {\n \"rules\": [\n {\n \"strategy\": \"cart_total\",\n \"operator\": \"lt\",\n \"args\": [\n 1000\n ]\n }\n ],\n \"actions\": [\n {\n \"strategy\": \"cart_discount\",\n \"args\": [\n \"percent\",\n 10\n ]\n }\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28ccefa7-7011-45a5-a0fe-bc1e0bdf6a5e", "name": "Delete a Rule Promotion", "request": { "name": "Delete a Rule Promotion", "description": { "content": "Deletes an existing Rule Promotion identified by its promotion ID.\n\n- This action **permanently removes** the promotion and cannot be undone.\n- If the promotion is active, please ensure that its removal does not impact ongoing campaigns.\n\nA successful request returns a `204 No Content` response, indicating that the promotion has been deleted.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the promotion.", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a1fb699b-08a3-4522-8147-447294472b62", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Rule Promotion Codes", "description": "", "item": [ { "id": "a26a8ff3-7633-4ff6-9935-198cdcd38e50", "name": "Create Rule Promotion Codes", "request": { "name": "Create Rule Promotion Codes", "description": { "content": "Creates new promotion codes for a specific rule promotion, allowing customers to redeem discounts based on predefined conditions.\n\n- Supports bulk creation of multiple promotion codes in a single request.\n- Each code can have individual usage limits.\n- Can optionally assign codes to specific users to enforce targeted promotions.\n- The promotion codes are case-insensitive.\n\n:::note\n\nRegarding first time shopper limitations:\n- Orders without payment transactions do not count as completed purchases.\n- Canceling or refunding an order does not reinstate first-time shopper status.\n- A first-time shopper coupon code cannot have limited uses or be assigned to specific users, meaning the code cannot be restricted by the number of times it can be used or tied to a specific customer ID.\n\n:::\n\nA successful request returns a `201 Created` response with details of the generated promotion codes.\n\n### Duplicate Codes\nDuplicate promotion codes **are supported across different promotions** in the store, regardless of their statuses and validity dates. However, **duplicate codes cannot be created within the same promotion**.\nThis means that shoppers can apply a single coupon code to trigger multiple promotions if those promotions share common coupon codes. \n\nCodes that share the same name can serve different purposes. For example, one code may have `per_application` with a limited number of uses, while another identical code can have `per_checkout` with unlimited use.\n\n**Duplicate Code Handling:**\n- If a duplicate code is detected **within the same promotion**, the request will return a `422 Duplicate code` error.\n- When creating duplicate codes, a message appears with the successful response indicating the duplication.\n\n\nPlease refer to the **OpenAPI examples** section on this page for sample request structures.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"promotion_codes\",\n \"codes\": [\n {\n \"code\": \"spring2024\"\n },\n {\n \"code\": \"summer2024\",\n \"consume_unit\": \"per_checkout\"\n },\n {\n \"code\": \"summer2024_limited\",\n \"consume_unit\": \"per_application\",\n \"uses\": 5\n },\n {\n \"code\": \"summer2024_memberOnly\",\n \"consume_unit\": \"per_application\",\n \"uses\": 1,\n \"user\": \"vip_shopper@email.com\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f7280413-caab-4e97-bfe2-a3e859333991", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"promotion_codes\",\n \"codes\": [\n {\n \"code\": \"spring2024\"\n },\n {\n \"code\": \"summer2024\",\n \"consume_unit\": \"per_checkout\"\n },\n {\n \"code\": \"summer2024_limited\",\n \"consume_unit\": \"per_application\",\n \"uses\": 5\n },\n {\n \"code\": \"summer2024_memberOnly\",\n \"consume_unit\": \"per_application\",\n \"uses\": 1,\n \"user\": \"vip_shopper@email.com\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"8a1c73bc-7c15-41c3-a3ed-a0aa398c3984\",\n \"code\": \"one_per_shopper\",\n \"user\": \"5abb8d4e-57c0-459b-91d5-c4e6f77e9c5e\",\n \"max_uses_per_shopper\": {\n \"max_uses\": 1,\n \"includes_guests\": false\n },\n \"consume_unit\": \"per_checkout\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c98c779-755e-440f-a926-0d23577179c9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"promotion_codes\",\n \"codes\": [\n {\n \"code\": \"spring2024\"\n },\n {\n \"code\": \"summer2024\",\n \"consume_unit\": \"per_checkout\"\n },\n {\n \"code\": \"summer2024_limited\",\n \"consume_unit\": \"per_application\",\n \"uses\": 5\n },\n {\n \"code\": \"summer2024_memberOnly\",\n \"consume_unit\": \"per_application\",\n \"uses\": 1,\n \"user\": \"vip_shopper@email.com\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"source\": \"data.codes.0.max_uses_per_shopper\",\n \"title\": \"missing_dependency\",\n \"detail\": \"Has a dependency on max_uses\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92b67411-b36b-4338-b532-921f777f2cf6", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"promotion_codes\",\n \"codes\": [\n {\n \"code\": \"spring2024\"\n },\n {\n \"code\": \"summer2024\",\n \"consume_unit\": \"per_checkout\"\n },\n {\n \"code\": \"summer2024_limited\",\n \"consume_unit\": \"per_application\",\n \"uses\": 5\n },\n {\n \"code\": \"summer2024_memberOnly\",\n \"consume_unit\": \"per_application\",\n \"uses\": 1,\n \"user\": \"vip_shopper@email.com\"\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 \"errors\": [\n {\n \"status\": \"422\",\n \"source\": \"\",\n \"title\": \"Unsupported consume unit\",\n \"detail\": \"Consume unit 'per_application' is not supported when using 'max_uses_per_shopper' features.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0aa7cca-8d47-49a0-a28d-1465a84fc59d", "name": "Get Rule Promotion Codes", "request": { "name": "Get Rule Promotion Codes", "description": { "content": "Retrieves the list of promotion codes associated with a specific Rule Promotion.\n\n- Returns all codes generated for the given promotion ID, including details on usage limits and redemption status.\n- Supports both automatically generated and manually created promotion codes.\n- Can be used to verify whether a promotion code is still valid or has reached its usage limit.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This parameter accepts a filtering expression that uses specific operators and attributes. Promotion codes are case-insensitive.\n\nThe following operators and attributes are available when filtering on this endpoint. See [Supported Filtering Characters](/guides/Getting-Started/filtering#supported-characters).\n\n| Attribute | Type | Operator | Example |\n|:--------- |:---------|:------------|:---------------|\n| `code` | `string`, `number` | `eq`, `gt` | `eq(code,summer2024)`, `gt(code,2024)` |\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Specifies the order of the codes that will be returned.\n (This can only be one of code,-code)", "type": "text/plain" }, "key": "sort", "value": "-code" } ], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e67de666-9af4-4d4e-ab99-1144d3edad9f", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "This parameter accepts a filtering expression that uses specific operators and attributes. Promotion codes are case-insensitive.\n\nThe following operators and attributes are available when filtering on this endpoint. See [Supported Filtering Characters](/guides/Getting-Started/filtering#supported-characters).\n\n| Attribute | Type | Operator | Example |\n|:--------- |:---------|:------------|:---------------|\n| `code` | `string`, `number` | `eq`, `gt` | `eq(code,summer2024)`, `gt(code,2024)` |\n", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Specifies the order of the codes that will be returned.\n (This can only be one of code,-code)", "type": "text/plain" }, "key": "sort", "value": "-code" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 \"type\": \"string\",\n \"id\": \"2aa91ad8-bb71-7311-48fb-494737bc2204\",\n \"code\": \"string\",\n \"uses\": 9986,\n \"user\": \"string\",\n \"consume_unit\": \"per_application\",\n \"max_uses\": 8785,\n \"max_uses_per_shopper\": {\n \"max_uses\": 6532,\n \"includes_guests\": false\n },\n \"is_for_new_shopper\": true,\n \"created_by\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2002-11-05T22:16:37.317Z\"\n }\n }\n },\n {\n \"type\": \"string\",\n \"id\": \"b639714b-96a9-f6a0-3c8c-7ae1f5a217c9\",\n \"code\": \"string\",\n \"uses\": 2077,\n \"user\": \"string\",\n \"consume_unit\": \"per_application\",\n \"max_uses\": 8496,\n \"max_uses_per_shopper\": {\n \"max_uses\": 3589,\n \"includes_guests\": false\n },\n \"is_for_new_shopper\": true,\n \"created_by\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"1992-10-14T02:13:49.071Z\"\n }\n }\n }\n ],\n \"links\": {\n \"current\": \"https://vRcvdxHdRLLWvsjGOqdONrfW.wtybTFc,f\",\n \"first\": \"https://GZCIw.gujyR03w+M,KFsS2Dq9uW\",\n \"last\": \"http://tBZTrYftofAHIcODYUVWU.jqOeteL1qCr\",\n \"next\": \"https://Fxn.umfRpipgEGf0iKIA-1qs8WpPSv.tD4W6WMKUUdntxL.I.yJTvT\",\n \"prev\": \"https://ApapqUhlmdIDjTT.anhPOlxIDomavHj90AWUDTh\"\n },\n \"meta\": {\n \"page\": {\n \"current\": 7346,\n \"limit\": 9647,\n \"offset\": 2532,\n \"total\": 6001\n },\n \"results\": {\n \"total\": 9843,\n \"total_method\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4b50d0a-1d2b-4338-9136-06e2a96c596d", "name": "Delete Rule Promotion Codes", "request": { "name": "Delete Rule Promotion Codes", "description": { "content": "Deletes one or more promotion codes from a specific rule promotion.\n\n- Supports **bulk deletion**, allowing multiple codes to be removed in a single request.\n- Removes promotion codes permanently, making them unavailable for future use.\n- If a code has already been redeemed, it will be removed from the system but may still reflect in historical transactions.\n\nA successful request returns a `204 No Content` response, indicating the specified promotion codes have been deleted.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"promotion_codes\",\n \"codes\": [\n {\n \"code\": \"spring2024\"\n },\n {\n \"code\": \"summer2024\",\n \"consume_unit\": \"per_checkout\"\n },\n {\n \"code\": \"summer2024_limited\",\n \"consume_unit\": \"per_application\",\n \"uses\": 5\n },\n {\n \"code\": \"summer2024_memberOnly\",\n \"consume_unit\": \"per_application\",\n \"uses\": 1,\n \"user\": \"vip_shopper@email.com\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0b578f8a-63a1-416b-8353-fe7c281972df", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"promotion_codes\",\n \"codes\": [\n {\n \"code\": \"spring2024\"\n },\n {\n \"code\": \"summer2024\",\n \"consume_unit\": \"per_checkout\"\n },\n {\n \"code\": \"summer2024_limited\",\n \"consume_unit\": \"per_application\",\n \"uses\": 5\n },\n {\n \"code\": \"summer2024_memberOnly\",\n \"consume_unit\": \"per_application\",\n \"uses\": 1,\n \"user\": \"vip_shopper@email.com\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "941d6966-3c7d-4d85-a628-d72cd4d4407a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"promotion_codes\",\n \"codes\": [\n {\n \"code\": \"spring2024\"\n },\n {\n \"code\": \"summer2024\",\n \"consume_unit\": \"per_checkout\"\n },\n {\n \"code\": \"summer2024_limited\",\n \"consume_unit\": \"per_application\",\n \"uses\": 5\n },\n {\n \"code\": \"summer2024_memberOnly\",\n \"consume_unit\": \"per_application\",\n \"uses\": 1,\n \"user\": \"vip_shopper@email.com\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 9901,\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"usage_ids\": [\n \"string\",\n \"string\"\n ]\n }\n },\n {\n \"status\": \"string\",\n \"title\": \"string\",\n \"detail\": \"string\",\n \"source\": \"string\",\n \"meta\": {\n \"usage_ids\": [\n \"string\",\n \"string\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a3de392-af9c-49e2-94db-df96c3ad654e", "name": "Delete A Single Rule Promotion Code", "request": { "name": "Delete A Single Rule Promotion Code", "description": { "content": "Deletes a single promotion code from a specific rule promotion.\n\n- Permanently removes the specified promotion code, making it unavailable for future use.\n- Can be used to **revoke a specific code** without affecting other codes under the same promotion.\n- If the code has already been redeemed, it will still be removed from the system but may still reflect in historical transactions.\n\nA successful request returns a `204 No Content` response, indicating the specified promotion code has been deleted.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes", ":codeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "codeID", "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion code.", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2968a5af-ec19-4ca3-9b12-fa517f1cdf60", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes", ":codeID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion code.", "type": "text/plain" }, "type": "any", "value": "string", "key": "codeID" } ] }, "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Rule Promotion Jobs", "description": "", "item": [ { "id": "cbfb1102-bd0e-4df2-ad1a-9a0ae1757340", "name": "Create a Rule Promotion Job", "request": { "name": "Create a Rule Promotion Job", "description": { "content": "Creates an asynchronous job for a specific Rule Promotion. Jobs are used to generate or export promotion codes in bulk.\n\nThe following job types are supported:\n- **`code_generate`**: Generates a batch of unique promotion codes.\n- **`code_export`**: Exports all existing promotion codes as a downloadable CSV file.\n\nJob processing occurs asynchronously. The job request is queued, and its status must be checked separately.\n\n### Job Processing Status\nJobs can have the following statuses:\n- `pending`: Job is in the queue, waiting to be processed.\n- `processing`: Job is actively being processed.\n- `completed`: Job completed successfully.\n- `failed`: Job encountered an error and did not complete.\n- `cancelling`: Cancellation in progress (for long-running jobs).\n- `cancelled`: Job was successfully cancelled.\n\nPlease refer to the **OpenAPI examples** section on this page for sample job creation requests.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", ":uuid", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"promotion_job\",\n \"job_type\": \"code_generate\",\n \"name\": \"Demo bulk code generate\",\n \"parameters\": {\n \"number_of_codes\": 100,\n \"max_uses_per_code\": 1,\n \"consume_unit\": \"per_checkout\",\n \"code_prefix\": \"summer-\",\n \"code_length\": 8\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "75552a7a-e090-4e32-aa75-6b2787e651d2", "name": "Promotion job created", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":uuid", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"promotion_job\",\n \"job_type\": \"code_generate\",\n \"name\": \"Demo bulk code generate\",\n \"parameters\": {\n \"number_of_codes\": 100,\n \"max_uses_per_code\": 1,\n \"consume_unit\": \"per_checkout\",\n \"code_prefix\": \"summer-\",\n \"code_length\": 8\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"job_type\": \"code_generate\",\n \"name\": \"string\",\n \"parameters\": {\n \"number_of_codes\": 188,\n \"max_uses_per_code\": 658,\n \"consume_unit\": \"per_application\",\n \"code_prefix\": \"string\",\n \"code_length\": 8\n },\n \"id\": \"string\",\n \"type\": \"string\",\n \"rule_promotion_id\": \"string\",\n \"status\": \"failed\",\n \"error\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2024-11-28T10:56:23.711Z\",\n \"updated_at\": \"1971-10-10T13:51:39.606Z\"\n }\n },\n \"result\": {\n \"generated\": 1000,\n \"deleted\": 50\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aed73060-0b83-496c-92c9-3944a814c4da", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":uuid", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"promotion_job\",\n \"job_type\": \"code_generate\",\n \"name\": \"Demo bulk code generate\",\n \"parameters\": {\n \"number_of_codes\": 100,\n \"max_uses_per_code\": 1,\n \"consume_unit\": \"per_checkout\",\n \"code_prefix\": \"summer-\",\n \"code_length\": 8\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"400\",\n \"title\": \"Too many jobs\",\n \"detail\": \"Only 1 pending or processing job is allowed per promotion.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9fda0027-8982-4f99-b7d4-f72f5030ae6d", "name": "Get Rule Promotion Jobs", "request": { "name": "Get Rule Promotion Jobs", "description": { "content": "Retrieves a list of jobs associated with a specific rule promotion. Each job represents an asynchronous operation such as promotion code generation or export.\n\nThe response includes details such as:\n- **Job type** (`code_generate` or `code_export`)\n- **Job status** (`pending`, `processing`, `completed`, `failed`, `cancelling`, or `cancelled`)\n- **Parameters used** (such as number of codes generated)\n- **Results** (such as number of codes successfully generated or deleted)\n\n### Filtering\nYou can filter jobs by:\n- **Job Type** (`eq(job_type, code_export)`)\n- **Status** (`eq(status, complete)`)\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", ":uuid", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies filter attributes.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "type": "any", "value": "string", "key": "uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of a rule promotion.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "85f4420c-0904-4ccb-a819-ec049b1884f6", "name": "Successful response", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":uuid", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specifies filter attributes.", "type": "text/plain" }, "key": "filter", "value": "string" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "uuid" } ] }, "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 \"job_type\": \"code_export\",\n \"name\": \"string\",\n \"parameters\": {\n \"number_of_codes\": 398,\n \"max_uses_per_code\": 4226,\n \"consume_unit\": \"per_application\",\n \"code_prefix\": \"string\",\n \"code_length\": 8\n },\n \"id\": \"string\",\n \"type\": \"string\",\n \"rule_promotion_id\": \"string\",\n \"status\": \"cancelled\",\n \"error\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"1964-02-16T07:30:41.019Z\",\n \"updated_at\": \"1999-09-28T05:30:26.715Z\"\n }\n },\n \"result\": {\n \"generated\": 1000,\n \"deleted\": 50\n }\n },\n {\n \"job_type\": \"code_export\",\n \"name\": \"string\",\n \"parameters\": {\n \"number_of_codes\": 617,\n \"max_uses_per_code\": 8381,\n \"consume_unit\": \"per_checkout\",\n \"code_prefix\": \"string\",\n \"code_length\": 8\n },\n \"id\": \"string\",\n \"type\": \"string\",\n \"rule_promotion_id\": \"string\",\n \"status\": \"pending\",\n \"error\": \"string\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"1988-04-29T05:41:02.381Z\",\n \"updated_at\": \"2016-11-18T10:24:29.827Z\"\n }\n },\n \"result\": {\n \"generated\": 1000,\n \"deleted\": 50\n }\n }\n ],\n \"links\": {\n \"current\": \"http://zUvmPSsiCVrMVC.laHjwraoXpJcqIjbxOEGS1x+-Vlvy-V\",\n \"first\": \"http://PcSguJOMpYPGwoNQAwfwMXQB.jwgRWJLLmVV5dUNtYgDrYBxGgwJg\",\n \"last\": \"https://EwaMnLebmJsDnqcYu.xhrP9cibCwZ2G,ACSUWqp-hMA7SEqg.J\",\n \"next\": \"http://GlPcZiQXVSxtpuFqijjC.jgOYHhZstZDGMSWk6NQ\",\n \"prev\": \"https://noYwaZsCZZgWwcjyUmkBcGaDPYFVCKSM.wnflkvo\"\n },\n \"meta\": {\n \"page\": {\n \"current\": 3552,\n \"limit\": 6021,\n \"offset\": 7830,\n \"total\": 1608\n },\n \"results\": {\n \"total\": 5917,\n \"total_method\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76694da4-50b8-4dd3-8016-54ef778f92e1", "name": "Get Rule Promotion Code Exported File", "request": { "name": "Get Rule Promotion Code Exported File", "description": { "content": "Retrieves the exported promotion codes for a rule promotion job in a CSV format.\n\n- The file contains the generated codes along with relevant metadata.\n- This endpoint is applicable only for jobs of type `code_export`.\n- The job must be in a `completed` state before the file can be retrieved.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", ":uuid", "jobs", ":job-uuid", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "job-uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the job associated with the file.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6c3da3c6-8a91-49e6-b971-13040ca47680", "name": "Successful response", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":uuid", "jobs", ":job-uuid", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the job associated with the file.", "type": "text/plain" }, "type": "any", "value": "string", "key": "job-uuid" } ] }, "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 \"href\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c020ac82-8abc-4de0-84db-f8e6fafd65e5", "name": "Cancel a Rule Promotion Job", "request": { "name": "Cancel a Rule Promotion Job", "description": { "content": "Cancels an asynchronous job for a rule promotion if its status is `pending` or `processing`.\n\n- Only jobs that have not yet completed can be canceled.\n- Once canceled, no further processing occurs, and partially completed results may be deleted.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", ":uuid", "jobs", ":job-uuid", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "string", "key": "uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "job-uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the job to be canceled.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b4b90cdc-da5a-49e9-8551-add106a53d8a", "name": "Successfully Canceled the Rule Promotion Job", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":uuid", "jobs", ":job-uuid", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the job to be canceled.", "type": "text/plain" }, "type": "any", "value": "string", "key": "job-uuid" } ] }, "header": [ { "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": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"promotion_job\",\n \"id\": \"9bc1391c-1b65-419e-940e-66ed86c07001\",\n \"rule_promotion_id\": \"8c150382-b258-4c88-a2d4-b9ea0be74a07\",\n \"job_type\": \"code_generate\",\n \"name\": \"Demo bulk code generate\",\n \"parameters\": {\n \"number_of_codes\": 100,\n \"max_uses_per_code\": 1,\n \"consume_unit\": \"per_checkout\",\n \"code_prefix\": \"summer-\",\n \"code_length\": 8\n },\n \"status\": \"cancelling\",\n \"meta\": {\n \"timestamps\": {\n \"created_at\": \"2024-12-03T23:31:40.962680423Z\",\n \"updated_at\": \"2024-12-03T23:31:40.962680423Z\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0af40295-eda1-47a1-a171-c5b4823f18da", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":uuid", "jobs", ":job-uuid", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the job to be canceled.", "type": "text/plain" }, "type": "any", "value": "string", "key": "job-uuid" } ] }, "header": [ { "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": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": \"422\",\n \"title\": \"Unprocessable Entity\",\n \"detail\": \"Only pending or processing jobs can be cancelled.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Rule Promotion Usages", "description": "", "item": [ { "id": "b70a41bd-9fee-4085-8e0b-70fa5e3504a0", "name": "Anonymize Rule Promotion Usages", "request": { "name": "Anonymize Rule Promotion Usages", "description": { "content": "Anonymizes user-related data in Rule Promotion usage records. \nThis operation is typically used for GDPR compliance or privacy-related requests.\n\n- This process replaces identifiable user data with anonymized placeholders.\n- Affects all recorded promotion usages where customer data is stored.\n- Does not impact historical transaction records or applied discounts.\n\nA successful request returns a `200 OK` response with the anonymized usage records.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", "usages", "anonymize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"usage_ids\": [\n \"ca4385ec-7fb2-4a95-8690-f752c508d68a\",\n \"d4e5f6g7-h8i9-0j1k-2l3m-4n5o6p7q8r9s\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b72bd1b6-1db4-41b5-9358-306b791a786d", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", "usages", "anonymize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"usage_ids\": [\n \"ca4385ec-7fb2-4a95-8690-f752c508d68a\",\n \"d4e5f6g7-h8i9-0j1k-2l3m-4n5o6p7q8r9s\"\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\": \"ca4385ec-7fb2-4a95-8690-f752c508d68a\",\n \"order_id\": \"8edd5ca8-39b7-468d-aea9-a470690ca98d\",\n \"code_id\": \"00fc633b-9932-4e18-b122-fd5c3173caa3\",\n \"code\": \"node1off\",\n \"times_used\": 1,\n \"used_on\": \"2023-06-19T18:05:20.846Z\",\n \"customer_id\": \"9ef25142-d67a-41d3-99b2-4d30aeef6c9d\",\n \"customer_email\": \"**\",\n \"meta\": {\n \"timestamps\": {\n \"updated_at\": \"2023-06-19T18:05:39.141Z\"\n }\n },\n \"updated_by\": \"Key-2439657140697170361\",\n \"anonymized\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0a2f6a5-93b8-45e6-a43e-df58f25b2328", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", "usages", "anonymize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"usage_ids\": [\n \"ca4385ec-7fb2-4a95-8690-f752c508d68a\",\n \"d4e5f6g7-h8i9-0j1k-2l3m-4n5o6p7q8r9s\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Invalid Request\",\n \"detail\": \"The request payload is malformed or missing required fields.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67e53f23-958a-404e-9b94-717c3ba602f8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", "usages", "anonymize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"usage_ids\": [\n \"ca4385ec-7fb2-4a95-8690-f752c508d68a\",\n \"d4e5f6g7-h8i9-0j1k-2l3m-4n5o6p7q8r9s\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\",\n \"detail\": \"Authentication credentials were missing or incorrect.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e328e25-aca1-4fe9-a70a-2f9ad75d650c", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", "usages", "anonymize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"usage_ids\": [\n \"ca4385ec-7fb2-4a95-8690-f752c508d68a\",\n \"d4e5f6g7-h8i9-0j1k-2l3m-4n5o6p7q8r9s\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Usages Not Found\",\n \"detail\": \"Some usage IDs could not be found.\",\n \"meta\": {\n \"usage_ids\": [\n \"invalid-usage-id-1\",\n \"invalid-usage-id-2\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2f8c471-3b93-4ba3-856d-358f6668f85d", "name": "Get Rule Promotion Usages", "request": { "name": "Get Rule Promotion Usages", "description": { "content": "Retrieves a list of usage records for a specific Rule Promotion.\n\n- Provides details about when and how a promotion was used.\n- Can be filtered and paginated to refine results.\n- Useful for analyzing promotion effectiveness and customer engagement.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", ":promotionID", "usages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter attributes to refine the usage records. Supported attributes:\n- `id`: Filter by usage ID.\n- `code`: Filter by promotion code.\n- `used_on`: Filter by usage date with operators `gt`, `ge`, `le`, `lt`.\n", "type": "text/plain" }, "key": "filter", "value": "eq(code,cart1off)" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2d7acd3a-2e02-4ce4-bdd0-d624ec4cb4f6", "name": "Successful response", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID", "usages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter attributes to refine the usage records. Supported attributes:\n- `id`: Filter by usage ID.\n- `code`: Filter by promotion code.\n- `used_on`: Filter by usage date with operators `gt`, `ge`, `le`, `lt`.\n", "type": "text/plain" }, "key": "filter", "value": "eq(code,cart1off)" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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\": \"a9b73e4d-637f-4f1c-9b3e-2de1f8a70351\",\n \"order_id\": \"e3d7b9fa-4a90-4e98-bac2-d7a4b4f2f63f\",\n \"code_id\": \"8a2c3f47-9d3b-4562-8392-4e5e6cda3d2b\",\n \"code\": \"cart10off\",\n \"times_used\": 1,\n \"used_on\": \"2024-02-20T15:42:00.000Z\",\n \"customer_id\": \"4f3e8c5d-37e4-43fb-9276-d1b76f0c3a2a\",\n \"customer_email\": \"shopper@example.com\",\n \"meta\": {\n \"timestamps\": {\n \"updated_at\": \"2024-02-20T15:45:00.000Z\"\n }\n },\n \"updated_by\": \"Admin-User-123\"\n }\n ],\n \"links\": {\n \"first\": \"https://useast.api.elasticpath.com/v2/rule-promotions/123/usages?page%5Boffset%5D=0&page%5Blimit%5D=10\",\n \"last\": \"https://useast.api.elasticpath.com/v2/rule-promotions/123/usages?page%5Boffset%5D=90&page%5Blimit%5D=10\",\n \"prev\": null,\n \"next\": \"https://useast.api.elasticpath.com/v2/rule-promotions/123/usages?page%5Boffset%5D=10&page%5Blimit%5D=10\"\n },\n \"meta\": {\n \"pagination\": {\n \"total\": 100,\n \"limit\": 10,\n \"offset\": 0,\n \"current\": 1\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b49ac6ec-fd11-4898-bd06-cc5aca83732f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID", "usages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter attributes to refine the usage records. Supported attributes:\n- `id`: Filter by usage ID.\n- `code`: Filter by promotion code.\n- `used_on`: Filter by usage date with operators `gt`, `ge`, `le`, `lt`.\n", "type": "text/plain" }, "key": "filter", "value": "eq(code,cart1off)" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\",\n \"detail\": \"Authentication is required to access this resource.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "552ddf26-a001-41d2-b2b2-dae05b4065d7", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID", "usages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter attributes to refine the usage records. Supported attributes:\n- `id`: Filter by usage ID.\n- `code`: Filter by promotion code.\n- `used_on`: Filter by usage date with operators `gt`, `ge`, `le`, `lt`.\n", "type": "text/plain" }, "key": "filter", "value": "eq(code,cart1off)" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" } ] }, "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 \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Promotion Not Found\",\n \"detail\": \"No usages found for the specified promotion ID.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "445fa71f-2084-4fd6-b318-4413361871e1", "name": "Get Rule Promotion Code Usages", "request": { "name": "Get Rule Promotion Code Usages", "description": { "content": "Retrieves a list of usage records for a specific Rule Promotion code.\n\n- Provides insights into how many times a specific code was used.\n- Can be filtered and paginated to refine results.\n- Useful for tracking the performance of individual promotion codes.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes", ":code", "usages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter attributes to refine the results. Supported attributes:\n- `id`: Filter by usage ID.\n- `used_on`: Filter by date with operators `gt`, `ge`, `le`, `lt`.\n", "type": "text/plain" }, "key": "filter", "value": "gt(used_on,2024-02-01T00:00:00Z)" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "type": "any", "value": "string", "key": "promotionID", "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" } }, { "type": "any", "value": "string", "key": "code", "disabled": false, "description": { "content": "(Required) The specific promotion code for which to retrieve usage records.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c8ffe3a9-30ea-42be-8fc5-9e4e70234e1e", "name": "Successful response", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes", ":code", "usages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter attributes to refine the results. Supported attributes:\n- `id`: Filter by usage ID.\n- `used_on`: Filter by date with operators `gt`, `ge`, `le`, `lt`.\n", "type": "text/plain" }, "key": "filter", "value": "gt(used_on,2024-02-01T00:00:00Z)" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" }, { "disabled": false, "description": { "content": "(Required) The specific promotion code for which to retrieve usage records.", "type": "text/plain" }, "type": "any", "value": "string", "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": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"c2f45a8d-6ebf-4b6a-8b1c-d2e7c9e0f45f\",\n \"order_id\": \"1a3b5c7d-9e2f-4a5b-8c1d-6e3f9b0d4c5f\",\n \"code_id\": \"5d7e9f2b-3c4a-6b8d-1e9f-0a2b3c4d5e6f\",\n \"code\": \"holiday50\",\n \"times_used\": 2,\n \"used_on\": \"2024-02-18T10:30:00.000Z\",\n \"customer_id\": \"7e6c5d4b-3a2f-1e9d-8b0c-9f4e7d6c3b5a\",\n \"customer_email\": \"vipuser@example.com\",\n \"meta\": {\n \"timestamps\": {\n \"updated_at\": \"2024-02-18T10:35:00.000Z\"\n }\n },\n \"updated_by\": \"Admin-User-456\"\n }\n ],\n \"links\": {\n \"first\": \"https://useast.api.elasticpath.com/v2/rule-promotions/123/codes/holiday50/usages?page%5Boffset%5D=0&page%5Blimit%5D=10\",\n \"last\": \"https://useast.api.elasticpath.com/v2/rule-promotions/123/codes/holiday50/usages?page%5Boffset%5D=10&page%5Blimit%5D=10\",\n \"prev\": null,\n \"next\": \"https://useast.api.elasticpath.com/v2/rule-promotions/123/codes/holiday50/usages?page%5Boffset%5D=10&page%5Blimit%5D=10\"\n },\n \"meta\": {\n \"pagination\": {\n \"total\": 20,\n \"limit\": 10,\n \"offset\": 0,\n \"current\": 1\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df34cad0-f38a-4f68-9636-79bb03468f42", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes", ":code", "usages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter attributes to refine the results. Supported attributes:\n- `id`: Filter by usage ID.\n- `used_on`: Filter by date with operators `gt`, `ge`, `le`, `lt`.\n", "type": "text/plain" }, "key": "filter", "value": "gt(used_on,2024-02-01T00:00:00Z)" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" }, { "disabled": false, "description": { "content": "(Required) The specific promotion code for which to retrieve usage records.", "type": "text/plain" }, "type": "any", "value": "string", "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": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized\",\n \"detail\": \"Authentication is required to access this resource.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56cc4631-9a1e-4cd3-85cb-bef6e7f03532", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "rule-promotions", ":promotionID", "codes", ":code", "usages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter attributes to refine the results. Supported attributes:\n- `id`: Filter by usage ID.\n- `used_on`: Filter by date with operators `gt`, `ge`, `le`, `lt`.\n", "type": "text/plain" }, "key": "filter", "value": "gt(used_on,2024-02-01T00:00:00Z)" }, { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "10" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the rule promotion.", "type": "text/plain" }, "type": "any", "value": "string", "key": "promotionID" }, { "disabled": false, "description": { "content": "(Required) The specific promotion code for which to retrieve usage records.", "type": "text/plain" }, "type": "any", "value": "string", "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": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Promotion Code Not Found\",\n \"detail\": \"No usages found for the specified promotion code.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Settings", "description": "The Settings API allow you to configure global settings for your project.", "item": [ { "id": "089933f0-355d-4919-bcab-d960fba7464c", "name": "Get Project Settings", "request": { "name": "Get Project Settings", "description": { "content": "You can get all of the project settings via one API call using a `client_credential` token. The response is in object format as shown in the following example.\n\n:::note\n\nThe default `calculation_method` is `line`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "v2", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8008bf26-eabb-4bf7-ae8b-2bac2045af1d", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "settings" ], "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" } ], "body": "{\n \"data\": {\n \"type\": \"settings\",\n \"page_length\": 25,\n \"list_child_products\": false,\n \"additional_languages\": [\n \"es\",\n \"fr\",\n \"de\"\n ],\n \"calculation_method\": \"line\",\n \"address_mandatory_fields\": [\n \"first_name\",\n \"last_name\",\n \"line_1\",\n \"city\",\n \"region\",\n \"postcode\",\n \"country\",\n \"instructions\"\n ],\n \"shopper_address_limit\": 25,\n \"id\": \"61daaa08-9z05-4497-b9ca-626cd0f9932b\",\n \"include_organization_resources\": false,\n \"cart_item_limit\": 100,\n \"custom_discount_limit\": 5,\n \"currency_limit\": 10,\n \"field_limit\": 100,\n \"integration_limit\": 100,\n \"event_limit\": 5,\n \"filter_limit\": 10,\n \"tax_item_limit\": 5,\n \"promotions_limit\": 1000,\n \"promotion_codes_limit\": 1000,\n \"page_offset_limit\": 10000\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eea61c5b-08c8-4541-b48f-f6dd3e41d9a1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "settings" ], "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 \"errors\": [\n {\n \"title\": \"Unauthorized\",\n \"status\": \"401\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea1b2bc1-ae8f-4848-8770-b5164c31784e", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "settings" ], "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ec8ded5-1206-4bba-90d4-578d1e56391f", "name": "Update Project Settings", "request": { "name": "Update Project Settings", "description": { "content": "You can use the Settings endpoint to update your project settings at any time. These global settings take immediate effect.", "type": "text/plain" }, "url": { "path": [ "v2", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"type\": \"settings\",\n \"page_length\": 25,\n \"list_child_products\": false,\n \"additional_languages\": [\n \"es\",\n \"fr\",\n \"de\"\n ],\n \"calculation_method\": \"line\",\n \"address_mandatory_fields\": [\n \"first_name\",\n \"last_name\",\n \"line_1\",\n \"city\",\n \"region\",\n \"postcode\",\n \"country\",\n \"instructions\"\n ],\n \"shopper_address_limit\": 25\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a9d23870-79c4-47cc-a540-465393abfea4", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"type\": \"settings\",\n \"page_length\": 25,\n \"list_child_products\": false,\n \"additional_languages\": [\n \"es\",\n \"fr\",\n \"de\"\n ],\n \"calculation_method\": \"line\",\n \"address_mandatory_fields\": [\n \"first_name\",\n \"last_name\",\n \"line_1\",\n \"city\",\n \"region\",\n \"postcode\",\n \"country\",\n \"instructions\"\n ],\n \"shopper_address_limit\": 25\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"settings\",\n \"page_length\": 25,\n \"list_child_products\": false,\n \"additional_languages\": [\n \"es\",\n \"fr\",\n \"de\"\n ],\n \"calculation_method\": \"line\",\n \"address_mandatory_fields\": [\n \"first_name\",\n \"last_name\",\n \"line_1\",\n \"city\",\n \"region\",\n \"postcode\",\n \"country\",\n \"instructions\"\n ],\n \"shopper_address_limit\": 25,\n \"id\": \"61daaa08-9z05-4497-b9ca-626cd0f9932b\",\n \"include_organization_resources\": false,\n \"cart_item_limit\": 100,\n \"custom_discount_limit\": 5,\n \"currency_limit\": 10,\n \"field_limit\": 100,\n \"integration_limit\": 100,\n \"event_limit\": 5,\n \"filter_limit\": 10,\n \"tax_item_limit\": 5,\n \"promotions_limit\": 1000,\n \"promotion_codes_limit\": 1000,\n \"page_offset_limit\": 10000\n },\n \"meta\": {\n \"owner\": \"store\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3f80ffa-4a19-4792-9303-12b674311149", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"type\": \"settings\",\n \"page_length\": 25,\n \"list_child_products\": false,\n \"additional_languages\": [\n \"es\",\n \"fr\",\n \"de\"\n ],\n \"calculation_method\": \"line\",\n \"address_mandatory_fields\": [\n \"first_name\",\n \"last_name\",\n \"line_1\",\n \"city\",\n \"region\",\n \"postcode\",\n \"country\",\n \"instructions\"\n ],\n \"shopper_address_limit\": 25\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"enum\",\n \"source\": \"data.type\",\n \"detail\": \"data.type must be one of the following: \\\"settings\\\"\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7b2bc32-53a4-4379-a76c-12ca4b4e435f", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"type\": \"settings\",\n \"page_length\": 25,\n \"list_child_products\": false,\n \"additional_languages\": [\n \"es\",\n \"fr\",\n \"de\"\n ],\n \"calculation_method\": \"line\",\n \"address_mandatory_fields\": [\n \"first_name\",\n \"last_name\",\n \"line_1\",\n \"city\",\n \"region\",\n \"postcode\",\n \"country\",\n \"instructions\"\n ],\n \"shopper_address_limit\": 25\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7348fb5b-1885-4e96-b27a-29ecd84994bd", "name": "Delete Project Settings", "request": { "name": "Delete Project Settings", "description": { "content": "Deletes a store setting. Organization settings cannot be deleted.", "type": "text/plain" }, "url": { "path": [ "v2", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "68bebf92-37a0-4578-b7d9-5c4eef29f7e2", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "9fa54c98-7122-4963-97be-bed4db9b6247", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "settings" ], "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": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Unauthorized\",\n \"status\": \"401\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87048214-9550-4a32-883a-f548d9a6929f", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "settings" ], "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": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}\n", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Authentication Realms", "description": "An authentication realm is a container that consists of the following:\n\n - Users - Represented by [User Authentication Info](/docs/api/single-sign-on/user-authentication-infos) objects\n - Authentication profiles - Ways for the users to authenticate, such as one or more [OpenID Connect Profiles](/docs/api/single-sign-on/oidc-profiles) or [Password Profiles](/docs/api/single-sign-on/password-profiles)\n - Mappings between users and authentication profiles - [User Authentication OpenID Connect Profile Info](/docs/api/single-sign-on/user-authentication-oidc-profile-infos) or [User Authentication Password Profile Infos](/docs/api/single-sign-on/user-authentication-password-profile-infos)\n\nHere's a domain diagram showing these relationships\n![authentication realm](/assets/authentication-realm-domain.png)\n\nComposable Commerce comes with three per-store pre-set realms:\n - Buyer Organization. For customers: users who buy products from your store.\n - Merchant Organization. For administrators: users who log in to Commerce Manager to modify the store’s settings or catalog.\n - Account Management Realm. For account members: users who buy products from your store on behalf of accounts. Password profiles are only available for account management realm.\n", "item": [ { "id": "a0c299fc-49f1-416d-b439-9b19d9b5f748", "name": "Get all Authentication Realms", "request": { "name": "Get all Authentication Realms", "description": { "content": "Retrieve a list of all authentication realms configured for your store.\nAuthentication Realms allow you to configure authentication options and manage single sign-on settings. Each realm contains users, authentication profiles, and mappings between users and authentication profiles.\n", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4c168790-6282-42a7-a562-f08a9c633575", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "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\": \"45928070-44a6-448b-8246-a85aa35320af\",\n \"type\": \"authentication-realm\",\n \"name\": \"Buyer Organization\",\n \"duplicate_email_policy\": \"allowed\",\n \"redirect_uris\": [\n \"https://example-shop.com/oidc/callback\"\n ],\n \"relationships\": {\n \"origin\": {\n \"data\": {\n \"id\": \"0\",\n \"type\": \"customer-authentication-settings\"\n }\n }\n }\n },\n {\n \"id\": \"bbd4a3f8-6a93-44a2-8f4f-2a1e3f8b3b9c\",\n \"type\": \"authentication-realm\",\n \"name\": \"Merchant Organization\",\n \"duplicate_email_policy\": \"disallowed\",\n \"redirect_uris\": [\n \"https://cm.example.com/oidc/callback\"\n ],\n \"relationships\": {\n \"origin\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"merchant-realm-mappings\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2\n },\n \"page\": {\n \"limit\": 25,\n \"offset\": 0\n }\n },\n \"links\": {\n \"current\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/?page%5Boffset%5D=0&page%5Blimit%5D=25\",\n \"first\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/?page%5Boffset%5D=0&page%5Blimit%5D=25\",\n \"last\": null,\n \"next\": null,\n \"prev\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f3cc017-db57-4a23-8a8c-699581da0c3f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2da61556-5484-49ab-ac1c-51e14f34bbf6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v2", "authentication-realms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "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 \"errors\": [\n {\n \"title\": \"Unauthorized\",\n \"status\": \"401\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fd6614b-bbf0-4247-b570-78329a19d10f", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "723ec932-7a0a-47c8-ab10-c9fc686e9e89", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52eccb61-6c4c-4c21-aa78-d8b574241def", "name": "Get an Authentication Realm", "request": { "name": "Get an Authentication Realm", "description": { "content": "Retrieve a specific authentication realm by its ID.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ada54b3c-6c85-466c-bfca-6ffa0885c5b5", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm to retrieve.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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 \"id\": \"45928070-44a6-448b-8246-a85aa35320af\",\n \"type\": \"authentication-realm\",\n \"name\": \"Buyer Organization\",\n \"duplicate_email_policy\": \"allowed\",\n \"redirect_uris\": [\n \"https://example-shop.com/oidc/callback\"\n ],\n \"relationships\": {\n \"origin\": {\n \"data\": {\n \"id\": \"0\",\n \"type\": \"customer-authentication-settings\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7b91417-c781-4db0-894c-99eb9d2257da", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm to retrieve.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "665395ba-34b0-4ff9-b511-b4058e00d777", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm to retrieve.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c56dfae-fd01-452c-a6b3-16ce32005d68", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm to retrieve.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a18ba76-4e55-4c4b-883b-6b7f7f86c893", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm to retrieve.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28a8a16e-d1d2-4d20-83dd-995ee8d34bc5", "name": "Update an Authentication Realm", "request": { "name": "Update an Authentication Realm", "description": { "content": "Update a specific authentication realm by its ID.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm to update.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"authentication-realm\",\n \"name\": \"updated-auth-realm\",\n \"duplicate_email_policy\": \"disallowed\",\n \"redirect_uris\": [\n \"https://updated-example.com/callback\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "010aa076-653d-423b-954f-0b52ef30e839", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm to update.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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 \"data\": {\n \"type\": \"authentication-realm\",\n \"name\": \"updated-auth-realm\",\n \"duplicate_email_policy\": \"disallowed\",\n \"redirect_uris\": [\n \"https://updated-example.com/callback\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-auth-realm\",\n \"duplicate_email_policy\": \"allowed\",\n \"redirect_uris\": [\n \"https://example.com/callback\"\n ],\n \"relationships\": {\n \"origin\": {\n \"data\": {\n \"id\": \"0\",\n \"type\": \"merchant-realm-mappings\"\n }\n }\n },\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/authentication-realms/deb6b25f-8451-4211-9a22-95610333df23\"\n }\n },\n \"links\": {\n \"self\": \"https://yIdXzP.uuiwh34kjp.u2l,Q16PLZdwEaGyhXnz9FfE78C76BjTCITpBL,LXJJA,Dag7NlJ6sjFKOufqef6THjjEcOCT4n3,4rUL8LLw-fMSv\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a68d6d4e-29da-4d05-bf2e-8f575b224ca5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm to update.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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 \"data\": {\n \"type\": \"authentication-realm\",\n \"name\": \"updated-auth-realm\",\n \"duplicate_email_policy\": \"disallowed\",\n \"redirect_uris\": [\n \"https://updated-example.com/callback\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0dfeb4f-dca1-46d0-a62f-7fbca5a85b37", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm to update.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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 \"data\": {\n \"type\": \"authentication-realm\",\n \"name\": \"updated-auth-realm\",\n \"duplicate_email_policy\": \"disallowed\",\n \"redirect_uris\": [\n \"https://updated-example.com/callback\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93c44c07-8667-4abf-b5ef-0a39d834df2b", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm to update.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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 \"data\": {\n \"type\": \"authentication-realm\",\n \"name\": \"updated-auth-realm\",\n \"duplicate_email_policy\": \"disallowed\",\n \"redirect_uris\": [\n \"https://updated-example.com/callback\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f4b6357-a160-4ea4-ba1e-93e632aed7be", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm to update.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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 \"data\": {\n \"type\": \"authentication-realm\",\n \"name\": \"updated-auth-realm\",\n \"duplicate_email_policy\": \"disallowed\",\n \"redirect_uris\": [\n \"https://updated-example.com/callback\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "OIDC Profiles", "description": "An OpenID Connect Profile resource represents a specific configuration of an OpenID Connect Provider.\n\nAn authentication realm can have multiple OpenID Connect Profiles. This allows shoppers to authenticate using multiple OpenID providers. In the example shown below, Jane can login using both Apple and Google, whereas Joan can only login using Google.\n\n![oidc profiles](/assets/oidc-profiles.png)\n", "item": [ { "id": "0681b79f-8aec-4bf1-8150-5dd15a5851df", "name": "Create an OIDC Profile", "request": { "name": "Create an OIDC Profile", "description": { "content": "Create an OpenID Connect profile for the specified authentication realm.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c52b0520-c8fc-47d0-8ce1-cf3df00db98e", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"created_at\": \"2025-09-08T20:58:56.355Z\",\n \"updated_at\": \"2025-09-08T20:58:56.355Z\",\n \"issuer\": \"https://test.issuer.com\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/authentication-realms/deb6b25f-8451-4211-9a22-95610333df23/oidc-profiles/abc123\",\n \"authorization-endpoint\": \"https://aHSZecVLnezgAvHBosIibYTqnAZqUI.qplFn,03eYNE,,sjWOZSBSltmymdo0eoWiyqCU6Ql\",\n \"callback-endpoint\": \"http://MDhKdrGVjSis.kyEVjif0fUrhM4wg+FA2NrjikMtBNhlx1Fx4e45vjd-X5NdmXADdAECll7l\",\n \"client-discovery-url\": \"http://lVyybpAhPbcxjpxm.snspBjpWPlR8ZJLGK,hTPB5K-QHcTL,Ya0ifCIn083czfCOMWG1a+x\"\n }\n },\n \"links\": {\n \"self\": \"http://zUAZAFmOlUdoTMqEibUDRIwY.frdmelvOTrqbK6VU5H-Vb-\",\n \"authorization-endpoint\": \"http://vkUolrStpaOE.rajf5mC-Df5UZnAU+T8UHlv2SK2-Zod5QK\",\n \"callback-endpoint\": \"https://WqyreMphkCASvYJhhJmbGavidKuWSdMw.bjayXNnvNXq,NHNanvkzOsy2eOdNgqZfAiheeSQH9UOoF\",\n \"client-discovery-url\": \"https://AnKQuUabpUCkorVDnUZNSCAcagboAMyPu.wtcenikS3hPjZVdEOM+\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1f57b4b-ac6b-4966-abfb-70126f5b9111", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44966f84-1463-4154-a3b5-377c81a512e1", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdc90dfd-c9ed-429d-b999-5180eba2ad06", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f70b666-3b8e-41d9-b075-3c467f2696ae", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c731f759-28e1-4b9d-8b9a-28c5cb845cf4", "name": "Get OIDC Profiles", "request": { "name": "Get OIDC Profiles", "description": { "content": "Retrieve OIDC profiles for the specified authentication realm.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7b490adb-b055-4e88-bf33-4985af69e345", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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\": \"c8849022-c9c6-4888-9ca8-2bb78f445fb0\",\n \"type\": \"oidc-profile\",\n \"name\": \"Google\",\n \"issuer\": \"https://accounts.google.com\",\n \"client_id\": \"google-client-id\"\n },\n {\n \"id\": \"21be087e-faa6-41fc-9b51-6763a363ec2d\",\n \"type\": \"oidc-profile\",\n \"name\": \"Apple\",\n \"issuer\": \"https://appleid.apple.com\",\n \"client_id\": \"apple-client-id\"\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2\n },\n \"page\": {\n \"limit\": 25,\n \"offset\": 0\n }\n },\n \"links\": {\n \"current\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/oidc-profiles?page%5Boffset%5D=0&page%5Blimit%5D=25\",\n \"first\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/oidc-profiles?page%5Boffset%5D=0&page%5Blimit%5D=25\",\n \"last\": null,\n \"next\": null,\n \"prev\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1e83c01-0f0b-46bf-b9d1-a50c0a09ee2b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d7ce823-fdff-42de-8626-d67a8b3ed9c8", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9c5cd6e-57c2-4824-9abf-e487a905e950", "name": "Get OIDC Profile", "request": { "name": "Get OIDC Profile", "description": { "content": "Retrieve a specific OIDC profile by ID.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId", "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e6c2f65e-4839-4c4c-9233-ac3079b9937f", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"id\": \"c8849022-c9c6-4888-9ca8-2bb78f445fb0\",\n \"type\": \"oidc-profile\",\n \"name\": \"Google\",\n \"issuer\": \"https://accounts.google.com\",\n \"client_id\": \"google-client-id\"\n },\n \"links\": {\n \"self\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/oidc-profiles/c8849022-c9c6-4888-9ca8-2bb78f445fb0\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c44909c0-05f8-425b-8180-1c23d5f3b0db", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20ba4f85-1711-4a5c-96c3-54b31928dbc8", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97907d65-ed01-4f38-a315-e06c5ce86a5f", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60c0de05-448f-4536-99aa-f0e466dc1bef", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b0139b1-f756-49aa-baa1-60937f235774", "name": "Update OIDC Profile", "request": { "name": "Update OIDC Profile", "description": { "content": "Update a specific OIDC profile by ID.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId", "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "95b90e9d-7b3b-494e-ba78-a285ccc31784", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"created_at\": \"2025-09-08T20:58:56.355Z\",\n \"updated_at\": \"2025-09-08T20:58:56.355Z\",\n \"issuer\": \"https://test.issuer.com\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/authentication-realms/deb6b25f-8451-4211-9a22-95610333df23/oidc-profiles/abc123\",\n \"authorization-endpoint\": \"https://aHSZecVLnezgAvHBosIibYTqnAZqUI.qplFn,03eYNE,,sjWOZSBSltmymdo0eoWiyqCU6Ql\",\n \"callback-endpoint\": \"http://MDhKdrGVjSis.kyEVjif0fUrhM4wg+FA2NrjikMtBNhlx1Fx4e45vjd-X5NdmXADdAECll7l\",\n \"client-discovery-url\": \"http://lVyybpAhPbcxjpxm.snspBjpWPlR8ZJLGK,hTPB5K-QHcTL,Ya0ifCIn083czfCOMWG1a+x\"\n }\n },\n \"links\": {\n \"self\": \"http://zUAZAFmOlUdoTMqEibUDRIwY.frdmelvOTrqbK6VU5H-Vb-\",\n \"authorization-endpoint\": \"http://vkUolrStpaOE.rajf5mC-Df5UZnAU+T8UHlv2SK2-Zod5QK\",\n \"callback-endpoint\": \"https://WqyreMphkCASvYJhhJmbGavidKuWSdMw.bjayXNnvNXq,NHNanvkzOsy2eOdNgqZfAiheeSQH9UOoF\",\n \"client-discovery-url\": \"https://AnKQuUabpUCkorVDnUZNSCAcagboAMyPu.wtcenikS3hPjZVdEOM+\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08f2b8d1-d114-4bcd-b9bc-7abc2fe87945", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37c840b2-1c9c-444d-994f-bf764db3ae6b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb14e045-840e-4938-a5ac-bd3eb0a43ae4", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fee2580-7a80-487c-b106-7f2c31a525b5", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"my-oidc-profile\",\n \"discovery_url\": \"https://example.com/.well-known/openid_configuration\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "931b10d5-558a-4f6e-a043-7c478b1283e9", "name": "Delete OIDC Profile", "request": { "name": "Delete OIDC Profile", "description": { "content": "Delete a specific OIDC profile by ID.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId", "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d106236b-a0ca-447e-bb2a-13ad40a5df40", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "394d8d20-40bd-4723-8ba6-05f8af19113d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2f5d122-8680-4559-86b1-31e307ce7933", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10bddf4b-03df-4067-a5bc-95455fdce5cc", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0190f19b-034a-4c3e-baf5-f98ad3e33235", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "oidc-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Password Profiles", "description": "A `password_profile` resource represents a specific configuration that allows users to authenticate through username and password.\n\nPassword Profiles support One-Time Password Tokens, which can be used to use passwordless login or password reset.\n\nAn authentication realm can have multiple Password Profiles. You can use this flexibility in many ways. For instance, if you want to migrate an existing pool of users from another system with their own usernames and passwords, they can use one profile, while the rest of the users use another.\n\nAnother use case is enabling shopper impersonation, where shoppers can authenticate using their own username and password in one profile. Meanwhile, admins can have a different username and password for the same user in a separate profile, shown as the \"Impersonation Profile\". This process can be automated using a Backend-For-Frontend (BFE) or One-Time Password Tokens. In the example shown below, both John and Joan can log in with their credentials, and an admin can also log in as Joan using the \"Impersonation Profile\".\n\n![password profiles](/assets/password-profiles.png)\n", "item": [ { "id": "e99fa52c-2044-4977-9f21-a81c6dc11363", "name": "Get Password Profiles", "request": { "name": "Get Password Profiles", "description": { "content": "Retrieve password profiles for the specified authentication realm.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3cdf88cd-b7a3-4bc2-afec-823f290a6908", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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\": \"a2f6d4c0-1d2b-4b3a-9e5a-2f4b1c7d8e9f\",\n \"type\": \"password_profile\",\n \"name\": \"Default Passwords\",\n \"require_uppercase\": true,\n \"require_numbers\": true,\n \"min_length\": 10\n },\n {\n \"id\": \"b3e7f5a1-2c3d-4e4b-8f6a-3e5c2d8f9a0b\",\n \"type\": \"password_profile\",\n \"name\": \"Impersonation Profile\",\n \"require_uppercase\": false,\n \"require_numbers\": false,\n \"min_length\": 8\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2\n },\n \"page\": {\n \"limit\": 25,\n \"offset\": 0\n }\n },\n \"links\": {\n \"current\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/password-profiles?page%5Boffset%5D=0&page%5Blimit%5D=25\",\n \"first\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/password-profiles?page%5Boffset%5D=0&page%5Blimit%5D=25\",\n \"last\": null,\n \"next\": null,\n \"prev\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf4cb00b-f61a-4169-b9ab-498685bc0982", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee53a8e9-608e-4210-b574-bc88fa04c156", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8de48a0c-f728-4cc1-b76a-ba94a52aede6", "name": "Create Password Profile", "request": { "name": "Create Password Profile", "description": { "content": "Create a password profile for the specified authentication realm.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "31cf15db-af1c-4d30-bab9-307c37f94dc4", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true,\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/authentication-realms/deb6b25f-8451-4211-9a22-95610333df23/password-profiles/abc123\"\n }\n },\n \"links\": {\n \"self\": \"https://bPcukHzjdMtBJTEbnlSWORqnk.tegoUx,PXJVRfv9O4vbC1dmVRnsk-7HzMCSqBF3,swuiiIGEO5fwJbU+Rq2Wd8xXUxJuQxcub9I9Ze-tjU\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5aac5ce7-b5af-4ff7-a2f8-d523cdc7a351", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b19b9107-7393-4bac-8a35-85431531cf48", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fff212de-34b2-4daf-b49b-18db5c25116b", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a65ec8f7-f8a4-48c9-ac75-b9156ff8063e", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3978d215-7ab4-4a6a-811a-f0d56344b10a", "name": "Get Password Profile", "request": { "name": "Get Password Profile", "description": { "content": "Retrieve a specific password profile by ID.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId", "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a9b82075-b890-4c88-a23a-c30a4bdf8597", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"id\": \"a2f6d4c0-1d2b-4b3a-9e5a-2f4b1c7d8e9f\",\n \"type\": \"password_profile\",\n \"name\": \"Default Passwords\"\n },\n \"links\": {\n \"self\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/password-profiles/a2f6d4c0-1d2b-4b3a-9e5a-2f4b1c7d8e9f\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2c8fbf7-8f45-40a9-a7cb-93140c57e14e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da338f39-1aab-49ac-a008-f36f65c5541a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "396ec963-f1b1-4d21-bb2b-105dccc668c7", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "471ff85f-1b9f-4fb7-84c9-62dde3d23fd8", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "006e2d74-66cf-484f-b13e-84fabdfe0019", "name": "Update Password Profile", "request": { "name": "Update Password Profile", "description": { "content": "Update a specific password profile by ID.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId", "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "cc13de7d-6f1a-48ab-8bb7-631d7f55bbf3", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true,\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/authentication-realms/deb6b25f-8451-4211-9a22-95610333df23/password-profiles/abc123\"\n }\n },\n \"links\": {\n \"self\": \"https://bPcukHzjdMtBJTEbnlSWORqnk.tegoUx,PXJVRfv9O4vbC1dmVRnsk-7HzMCSqBF3,swuiiIGEO5fwJbU+Rq2Wd8xXUxJuQxcub9I9Ze-tjU\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64d0ad48-0e3a-480e-8f17-2ab58cd8f47f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04174266-3b72-4bb9-97b6-747674c6b410", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5c61996-3e1b-4b88-bc41-0e6d620b5aa5", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4370a33c-3b16-40e6-9a59-911b5dd3de2a", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"my-password-profile\",\n \"username_format\": \"email\",\n \"enable_one_time_password_token\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bbdbb726-ad4b-46bb-bb90-25fb4dd51e72", "name": "Delete Password Profile", "request": { "name": "Delete Password Profile", "description": { "content": "Delete a specific password profile by ID.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId", "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "a629049b-ea46-4291-9846-342c42cae358", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "d11037be-da6a-4ab8-996e-a7e64e92f62f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b5b0833-71d4-40dc-859c-1a49ffe7d586", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fbccf4d-0f62-4e5c-bb47-d6025fe7a301", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0d27dc9-dfa8-48af-8135-8c06d1f9446e", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cbed470f-1225-4f19-a61d-d746e1880d5c", "name": "Create One-Time Password Token Request", "request": { "name": "Create One-Time Password Token Request", "description": { "content": "Create a one-time password token request for the specified password profile.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId", "one-time-password-token-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId", "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"\",\n \"purpose\": \"reset_password\",\n \"username\": \"user@example.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "feeb57f8-13ab-46c4-9fd8-696461bd21ba", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId", "one-time-password-token-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"\",\n \"purpose\": \"reset_password\",\n \"username\": \"user@example.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"\",\n \"purpose\": \"reset_password\",\n \"username\": \"user@example.com\",\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"token\": \"123456\",\n \"expires_at\": \"2023-12-01T10:30:00Z\",\n \"meta\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2df668b2-f8a6-45d6-adc1-c398a7ee2bdf", "name": "Accepted", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId", "one-time-password-token-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "header": [ { "key": "Content-Type", "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 \"data\": {\n \"type\": \"\",\n \"purpose\": \"reset_password\",\n \"username\": \"user@example.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a1da7c6e-3042-41d2-8baa-638ac2589191", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId", "one-time-password-token-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"\",\n \"purpose\": \"reset_password\",\n \"username\": \"user@example.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec88be95-f70d-4bba-90c5-ced2417a2831", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId", "one-time-password-token-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"\",\n \"purpose\": \"reset_password\",\n \"username\": \"user@example.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6655f741-edfd-474e-b6d9-4a7993af58da", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId", "one-time-password-token-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"\",\n \"purpose\": \"reset_password\",\n \"username\": \"user@example.com\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "322ddb16-b30e-4bbc-ad9d-ff49c817ad8e", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "password-profiles", ":profileId", "one-time-password-token-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "profileId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"\",\n \"purpose\": \"reset_password\",\n \"username\": \"user@example.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "User Authentication Infos", "description": "\nA `user-authentication-info` represents a user. This object contains information, such as the name and email address, and has sub-resources for each mechanism that the user can use to log in./single-sign-on/authentication-realm-api/authentication-realm-api-overview) and the user is configured to authenticate through that profile, then the `user-authentication-info` object is associated with a [User Authentication OpenID Connect Profile Info](/docs/api/single-sign-on/user-authentication-oidc-profile-infos) subresource.\n\n[Account Members](/docs/api/accounts/get-v-2-account-members-account-member-id) reference User Authentication Infos directly (i.e., for every account member there is an user authentication info with the same id) and the User Authentication Info API is how you manage and configure the authentication options for that user.\n\n[Customers (that login via OIDC)](/docs/customer-management/customer-management-api/get-a-customer) also use the User Authentication Info.\n", "item": [ { "id": "1e979ed0-e45d-437f-8178-ce39c5a0c812", "name": "Get User Authentication Info List", "request": { "name": "Get User Authentication Info List", "description": { "content": "Retrieve user authentication information for the specified authentication realm.\n### Filtering\n\n\n The following operators and attributes are available for\n [filtering](/guides/Getting-Started/filtering) unassigned account members.\n\n\n | Operator | Description |\n | :------- |:--------------------------------------------------------------------------------------------------- |\n | `eq` | Matches record where the field matches the value (case insensitive) |\n | `ge` | Matches results where the value is greater than or equal to the operand |\n | `gt` | Matches results where the value is greater than the operand |\n | `le` | Matches results where the value is less than or equal to the operand |\n | `lt` | Matches results where the value is less than the operand |\n | `in` | Matches results where the value is in one of a set of values |\n | `ilike` | Checks whether the operand contains the specified string. You can use wildcard characters at the start or end. (Case Insensitive) |\n | `is_null` | Matches records where the field is null. |\n\n\n | Attribute | Type | Operator | Example\n | :-------- | :------- | :------------ | :--------------------------------- |\n | `email` | `string` | `eq`,`ilike` | `eq(email,ronswanson@example.com)` |\n | `name` | `string` | `eq`,`ilike` | `ilike(name,*swan*)` |\n | `created_at` | `string` | `lt`, `le`, `eq`, `gt`, `ge` | `lt(created_at,\"2025-09-10T22:08:47.992Z\")` |\n | `updated_at` | `string` | `lt`, `le`, `eq`, `gt`, `ge` | `gt(updated_at,\"2025-09-10T22:08:47.992Z\")` |\n | `given_name` | `string` | `eq`,`ilike`,`is_null` | `is_null('given_name')` |\n | `middle_name` | `string` | `eq`,`ilike`,`is_null` | `is_null('middle_name')` |\n | `family_name` | `string` | `eq`,`ilike`,`is_null` | `is_null('family_name')` |", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Specifies the order in which account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ae764de1-b3b2-4ee7-abb3-35e83a6fbc6a", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Specifies the order in which account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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\": \"40c8ecfa-0d1a-43b2-8d62-2bbbb6c4207c\",\n \"type\": \"user_authentication_info\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane.doe@example.com\"\n },\n {\n \"id\": \"ddb47241-2c69-42cd-b65f-32717cdcf9c1\",\n \"type\": \"user_authentication_info\",\n \"name\": \"John Smith\",\n \"email\": \"john.smith@example.com\"\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2\n },\n \"page\": {\n \"limit\": 25,\n \"offset\": 0\n }\n },\n \"links\": {\n \"current\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/user-authentication-info?page%5Boffset%5D=0&page%5Blimit%5D=25\",\n \"first\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/user-authentication-info?page%5Boffset%5D=0&page%5Blimit%5D=25\",\n \"last\": null,\n \"next\": null,\n \"prev\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dadb9c2-9879-4db8-823c-785c0ba64b3f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Specifies the order in which account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc79cf17-449c-4453-bef3-35b493e0936e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Specifies the order in which account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4104735-db28-4c5a-afc3-9f94d7bf50a6", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Specifies the order in which account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70ae4ac0-288c-4274-b608-f5d1cadf1bf3", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" }, { "disabled": false, "description": { "content": "Specifies the filter attributes.", "type": "text/plain" }, "key": "filter", "value": "string" }, { "disabled": false, "description": { "content": "Specifies the order in which account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting). (This can only be one of created_at,-created_at,id,-id,updated_at,-updated_at)", "type": "text/plain" }, "key": "sort", "value": "id" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "214b07e2-5962-41a6-86b9-6e5e49b665d1", "name": "Create User Authentication Info", "request": { "name": "Create User Authentication Info", "description": { "content": "Create user authentication information for the specified authentication realm.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "024e377a-1372-450b-93e7-f51c724864b3", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"created_at\": \"2025-09-08T20:29:42.282Z\",\n \"updated_at\": \"2025-09-08T20:29:42.282Z\",\n \"creation_status\": \"COMPLETE\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/authentication-realms/deb6b25f-8451-4211-9a22-95610333df23/user-authentication-info/abc123\"\n }\n },\n \"links\": {\n \"self\": \"https://JknmdXUb.tsXADMiDvJV8QTFQ\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6eee80d-b742-4a8b-bde0-08486eab6ca8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a831e98e-75d8-4e11-ac9a-00dad33ac4a4", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4bd8c74-09e0-4abb-b0bf-2e2a2677efa2", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f1485ee-95a3-41ed-9402-36926ed92649", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df4f525e-621c-4ab0-a0df-66543134eb82", "name": "Get User Authentication Info", "request": { "name": "Get User Authentication Info", "description": { "content": "Retrieve specific user authentication information by ID.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId", "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d316be63-af9d-4626-8ae0-f25272fea658", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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 \"id\": \"40c8ecfa-0d1a-43b2-8d62-2bbbb6c4207c\",\n \"type\": \"user_authentication_info\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane.doe@example.com\"\n },\n \"links\": {\n \"self\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/user-authentication-info/40c8ecfa-0d1a-43b2-8d62-2bbbb6c4207c\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6a61580-72e4-4fb9-b709-dec5ca2a8635", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adf11e92-67f6-4028-971a-9cdf52f9a83f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eea6f70d-8d77-4489-838f-bc9bce7319c5", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05db6656-e6e9-4323-a438-46dd7ba15e4a", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "518d09a1-186d-41c4-9231-60734ca3b07c", "name": "Update User Authentication Info", "request": { "name": "Update User Authentication Info", "description": { "content": "Update specific user authentication information by ID.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId", "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "87af17ee-a42b-473c-b70b-c8936faa13b2", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"created_at\": \"2025-09-08T20:29:42.282Z\",\n \"updated_at\": \"2025-09-08T20:29:42.282Z\",\n \"creation_status\": \"COMPLETE\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/authentication-realms/deb6b25f-8451-4211-9a22-95610333df23/user-authentication-info/abc123\"\n }\n },\n \"links\": {\n \"self\": \"https://JknmdXUb.tsXADMiDvJV8QTFQ\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e02aad7e-bec7-4c0f-8b8f-05be5c50deda", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "309723c7-2b56-441b-9899-b5b2e3fff14e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f50f220d-cdd0-4ba8-a813-a7dd9f4ac0c1", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53e6f472-167c-45aa-bebb-72afd796d5cb", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"name\": \"Ron Swanson\",\n \"email\": \"ron@swanson.com\",\n \"given_name\": \"Ron\",\n \"family_name\": \"Swanson\",\n \"middle_name\": \"Ulysses\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78256444-30d6-44a4-a7de-a0a08a3c0d71", "name": "Delete User Authentication Info", "request": { "name": "Delete User Authentication Info", "description": { "content": "Delete specific user authentication information by ID.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId", "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "9eef8f9e-0f1b-4809-972d-9868f0f5af81", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "7d011904-3f83-42da-9211-47f869a56cf1", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c6f23b5-ed17-45c1-9162-16f26bc86ac9", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4710b29-4718-49cc-adcb-ae993cc7cc13", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "User Authentication OIDC Profile Infos", "description": "The `user-authentication-oidc-profile-info` object is the information object about the relationship between a [User Authentication Info](/docs/api/single-sign-on/user-authentication-infos) and an [OpenID Connect Profile](/docs/api/single-sign-on/oidc-profiles).\n", "item": [ { "id": "a1b21d97-4cba-43b1-af4a-56c2724724c9", "name": "Create User Authentication OIDC Profile Info", "request": { "name": "Create User Authentication OIDC Profile Info", "description": { "content": "Create OIDC profile information for a specific user authentication info.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId", "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "faedefc0-c315-4f8e-b8c6-4005b6129e46", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/authentication-realms/deb6b25f-8451-4211-9a22-95610333df23/user-authentication-info/abc123/user-authentication-oidc-profile-info/def456\"\n }\n },\n \"links\": {\n \"self\": \"http://JjeFntUcOptGtaufDegqaYhsPUaQHSwH.jblcLs9ylTonxMOfb.pterkcUsOlo5+Ox8KMTClj9WKbgITNk8d.ll+nJAnDtl\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0818aa3-e19d-432d-8ad6-ba74bbf3423e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ee0f057-b974-4a5d-9586-9f059d786ba8", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05065ca7-ee10-41f2-980c-33d7bd0214f9", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fedbe05e-ac72-4cf2-b42f-82ab86c70059", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f98692a-5e49-4efe-a408-e90625538227", "name": "Get User Authentication OIDC Profile Info", "request": { "name": "Get User Authentication OIDC Profile Info", "description": { "content": "Retrieve OIDC profile information for a specific user authentication info.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId", "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "13cba496-e786-483f-a185-8f8aad11190d", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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\": \"f1a2b3c4-d5e6-47f8-9a0b-c1d2e3f4a5b6\",\n \"type\": \"user_authentication_oidc_profile_info\",\n \"oidc_profile_id\": \"c8849022-c9c6-4888-9ca8-2bb78f445fb0\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://accounts.google.com\"\n },\n {\n \"id\": \"0a1b2c3d-4e5f-6071-8a9b-bc0d1e2f3a4b\",\n \"type\": \"user_authentication_oidc_profile_info\",\n \"oidc_profile_id\": \"21be087e-faa6-41fc-9b51-6763a363ec2d\",\n \"subject\": \"subject-456\",\n \"issuer\": \"https://appleid.apple.com\"\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2\n },\n \"page\": {\n \"limit\": 25,\n \"offset\": 0\n }\n },\n \"links\": {\n \"current\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/user-authentication-info/40c8ecfa-0d1a-43b2-8d62-2bbbb6c4207c/user-authentication-oidc-profile-info?page%5Boffset%5D=0&page%5Blimit%5D=25\",\n \"first\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/user-authentication-info/40c8ecfa-0d1a-43b2-8d62-2bbbb6c4207c/user-authentication-oidc-profile-info?page%5Boffset%5D=0&page%5Blimit%5D=25\",\n \"last\": null,\n \"next\": null,\n \"prev\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a3e01ec-52ab-4183-bc20-d52553e6d35d", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69042fe9-8b0e-4b75-b771-82a08de15eda", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3582a2cd-48b9-4d52-947a-851dfe6d4030", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "afff44ad-77da-43ec-8ce2-aa9e120333a4", "name": "Get User Authentication OIDC Profile Info by ID", "request": { "name": "Get User Authentication OIDC Profile Info by ID", "description": { "content": "Retrieve specific OIDC profile information by ID for a user.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId", "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId", "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "82556ae4-b6e3-435a-b387-735956ca7fe5", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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 \"id\": \"f1a2b3c4-d5e6-47f8-9a0b-c1d2e3f4a5b6\",\n \"type\": \"user_authentication_oidc_profile_info\",\n \"oidc_profile_id\": \"c8849022-c9c6-4888-9ca8-2bb78f445fb0\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://accounts.google.com\"\n },\n \"links\": {\n \"self\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/user-authentication-info/40c8ecfa-0d1a-43b2-8d62-2bbbb6c4207c/user-authentication-oidc-profile-info/f1a2b3c4-d5e6-47f8-9a0b-c1d2e3f4a5b6\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac9423d1-083b-4ab1-ba2a-2419ece7bcc5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10525bd3-f9ad-48d3-9996-141cd4ee9849", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87aae0a5-266c-4de4-b041-b65823f3cc25", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "538d6c94-bc93-44ff-8e96-719a3dce75cb", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86a56ba2-16cd-48c0-9cfa-769fc80447b8", "name": "Update User Authentication OIDC Profile Info", "request": { "name": "Update User Authentication OIDC Profile Info", "description": { "content": "Update specific OIDC profile information by ID for a user.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId", "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId", "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ec0ffc06-49d4-4a00-be00-befdb9f67706", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/authentication-realms/deb6b25f-8451-4211-9a22-95610333df23/user-authentication-info/abc123/user-authentication-oidc-profile-info/def456\"\n }\n },\n \"links\": {\n \"self\": \"http://JjeFntUcOptGtaufDegqaYhsPUaQHSwH.jblcLs9ylTonxMOfb.pterkcUsOlo5+Ox8KMTClj9WKbgITNk8d.ll+nJAnDtl\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b588f324-cdcb-4811-9616-593112746d8d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02cc78fe-2e6e-4588-814d-b107f12a67ff", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "146dfae8-aa8c-497a-88b3-b87d708fd58a", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39c6696b-3192-4643-9464-30c9d523dc2a", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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 \"data\": {\n \"type\": \"string\",\n \"oidc_profile_id\": \"f1a2932f-3579-46f0-92e1-a4a80cd26e37\",\n \"subject\": \"subject-123\",\n \"issuer\": \"https://test.issuer.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6783b934-ed8f-4ff9-85f1-1affec482c41", "name": "Delete User Authentication OIDC Profile Info", "request": { "name": "Delete User Authentication OIDC Profile Info", "description": { "content": "Delete specific OIDC profile information by ID for a user.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId", "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId", "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "01edaf51-1abc-4e3f-83de-c2c1cedc2c5a", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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": "18529eb8-7d52-4acd-a127-1cb7404a8e7a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1218f6a3-7202-4aac-b121-829817f49f60", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d809b7c0-c380-46be-8692-26d2a5f6ac07", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d71b90bf-f5f0-4f71-ade9-e4ce82652de0", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-oidc-profile-info", ":oidcInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the OIDC profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "oidcInfoId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "User Authentication Password Profile Infos", "description": "The `user-authentication-password-profile-info` object is the information object about the relationship between a [User Authentication Info](/docs/api/single-sign-on/user-authentication-infos) and a [Password Profile](/docs/api/single-sign-on/password-profiles) object.", "item": [ { "id": "0769cc66-499d-4639-8181-794f0969ccb3", "name": "Get User Authentication Password Profile Info List", "request": { "name": "Get User Authentication Password Profile Info List", "description": { "content": "Retrieve a list of password profile information for a user.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId", "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cb5dc1fa-151b-4bab-9f70-99e702235fbc", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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\": \"9f8e7d6c-5b4a-3a2f-1e0d-c9b8a7f6e5d4\",\n \"type\": \"user_authentication_password_profile_info\",\n \"username\": \"uauppinamepestupdate@test.com\",\n \"password_profile_id\": \"a2f6d4c0-1d2b-4b3a-9e5a-2f4b1c7d8e9f\"\n },\n {\n \"id\": \"0c9b8a7f-6e5d-4c3b-2a1f-0e9d8c7b6a5f\",\n \"type\": \"user_authentication_password_profile_info\",\n \"username\": \"another.user@example.com\",\n \"password_profile_id\": \"b3e7f5a1-2c3d-4e4b-8f6a-3e5c2d8f9a0b\"\n }\n ],\n \"meta\": {\n \"results\": {\n \"total\": 2\n },\n \"page\": {\n \"limit\": 25,\n \"offset\": 0\n }\n },\n \"links\": {\n \"current\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/user-authentication-info/40c8ecfa-0d1a-43b2-8d62-2bbbb6c4207c/user-authentication-password-profile-info?page%5Boffset%5D=0&page%5Blimit%5D=25\",\n \"first\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/user-authentication-info/40c8ecfa-0d1a-43b2-8d62-2bbbb6c4207c/user-authentication-password-profile-info?page%5Boffset%5D=0&page%5Blimit%5D=25\",\n \"last\": null,\n \"next\": null,\n \"prev\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "338eb734-e8c9-47f7-82bc-8a7f23a1fbda", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d376dfb-15c8-4d63-8393-8e2a08ee6369", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of records per page.", "type": "text/plain" }, "key": "page[limit]", "value": "25" }, { "disabled": false, "description": { "content": "The number of records to offset the results by.", "type": "text/plain" }, "key": "page[offset]", "value": "0" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0434913d-79a8-45f3-a60b-9e1528843c87", "name": "Create User Authentication Password Profile Info", "request": { "name": "Create User Authentication Password Profile Info", "description": { "content": "Create password profile information for a specific user authentication info.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId", "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"password\": \"P@ssw0rd123!\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a2dd9cfc-ad07-40bf-9b2e-a4ff04986b56", "name": "Created", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"password\": \"P@ssw0rd123!\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/authentication-realms/deb6b25f-8451-4211-9a22-95610333df23/user-authentication-info/abc123/user-authentication-password-profile-info/def456\"\n }\n },\n \"links\": {\n \"self\": \"http://GrXHSvNLuIdSrnrtTufRHmPKREIo.xpjdLGfIrVknsgx1CYyosb5uUfWSutSl5Co,sJTR,1sQTET\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80c3b603-21d8-4e36-a7d2-8be526aad24f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"password\": \"P@ssw0rd123!\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c17da60f-30ac-449e-abe5-b6a45ba8dc51", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"password\": \"P@ssw0rd123!\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae37ab97-7cb9-42a3-b0f3-c38fc4605531", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"password\": \"P@ssw0rd123!\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b9db674-d947-418e-85ff-19ee8c5f4453", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"password\": \"P@ssw0rd123!\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e28cb94e-1c99-4872-b011-7f94e87bdbbd", "name": "Get User Authentication Password Profile Info by ID", "request": { "name": "Get User Authentication Password Profile Info by ID", "description": { "content": "Retrieve specific password profile information by ID for a user.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId", "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId", "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a2e1f7c0-2eed-4d71-9e14-910fbf2f31e1", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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 \"id\": \"9f8e7d6c-5b4a-3a2f-1e0d-c9b8a7f6e5d4\",\n \"type\": \"user_authentication_password_profile_info\",\n \"username\": \"uauppinamepestupdate@test.com\",\n \"password_profile_id\": \"a2f6d4c0-1d2b-4b3a-9e5a-2f4b1c7d8e9f\"\n },\n \"links\": {\n \"self\": \"https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/user-authentication-info/40c8ecfa-0d1a-43b2-8d62-2bbbb6c4207c/user-authentication-password-profile-info/9f8e7d6c-5b4a-3a2f-1e0d-c9b8a7f6e5d4\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c5e14d4-98f3-4ef9-816c-36afc0d6bfc4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3c0c9b8-1b50-4ce1-a19d-50eacdeb22ba", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da517238-438f-4c99-8fda-743a78bc0d68", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41778658-b9a1-458f-ac0e-392ea191f873", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d1bf9b1-9684-425a-a70e-cc8ac8e9f8d9", "name": "Update User Authentication Password Profile Info", "request": { "name": "Update User Authentication Password Profile Info", "description": { "content": "Update specific password profile information by ID for a user.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId", "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId", "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"password\": \"P@ssw0rd123!\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e38ea254-35fc-4d83-a309-eeeca77421b7", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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 \"data\": {\n \"password\": \"P@ssw0rd123!\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"id\": \"deb6b25f-8451-4211-9a22-95610333df23\",\n \"meta\": {\n \"created_at\": \"2021-02-23T09:40:33.882Z\",\n \"updated_at\": \"2021-02-23T09:40:33.882Z\"\n },\n \"links\": {\n \"self\": \"https://useast.api.elasticpath.com/v2/authentication-realms/deb6b25f-8451-4211-9a22-95610333df23/user-authentication-info/abc123/user-authentication-password-profile-info/def456\"\n }\n },\n \"links\": {\n \"self\": \"http://GrXHSvNLuIdSrnrtTufRHmPKREIo.xpjdLGfIrVknsgx1CYyosb5uUfWSutSl5Co,sJTR,1sQTET\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "581feeb5-6bd3-4ea0-a1de-237d424031e3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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 \"data\": {\n \"password\": \"P@ssw0rd123!\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a4c8c4c-7b6d-4e83-8ccc-798020e2685f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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 \"data\": {\n \"password\": \"P@ssw0rd123!\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d37552a-c4db-4013-b16b-fdb461516b75", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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 \"data\": {\n \"password\": \"P@ssw0rd123!\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82630cc5-e5e6-40e2-89d7-e9b5b60aa7b7", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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 \"data\": {\n \"password\": \"P@ssw0rd123!\",\n \"password_profile_id\": \"767e6763-014e-4b6e-8a0e-59b863ab3262\",\n \"type\": \"string\",\n \"username\": \"uauppinamepestupdate@test.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c2f01e0f-5d92-4c3a-bc84-ea04ad6bd418", "name": "Delete User Authentication Password Profile Info", "request": { "name": "Delete User Authentication Password Profile Info", "description": { "content": "Delete specific password profile information by ID for a user.", "type": "text/plain" }, "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId", "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId", "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "1f05b073-9156-4ddc-be14-960b50cc92dd", "name": "No Content", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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": "910d05d3-310a-422d-903c-661f0c04fc78", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Bad Request\",\n \"status\": \"400\",\n \"detail\": \"Validation failed: field 'Name' on the 'min' tag.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3838fbf-56fa-4c5f-b03b-de21ea7d084c", "name": "Not Found", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"Resource not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c94b6e0b-b1b2-4bbe-ba9d-e8338232873d", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Unprocessable Entity\",\n \"status\": \"422\",\n \"detail\": \"Constraint violation\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79845b16-39aa-44f1-b553-c6a96e6335b1", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v2", "authentication-realms", ":realmId", "user-authentication-info", ":userAuthInfoId", "user-authentication-password-profile-info", ":passwordProfileInfoId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" }, { "disabled": false, "description": { "content": "(Required) The ID of the user authentication info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "userAuthInfoId" }, { "disabled": false, "description": { "content": "(Required) The ID of the password profile info.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "passwordProfileInfoId" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\",\n \"detail\": \"there was a problem processing your request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "OIDC Authentication", "description": "The OIDC IDP Login endpoints handle the initiation of OpenID Connect authentication flows.\n\nWhen a user needs to authenticate via OIDC, they are redirected to these endpoints which then redirect them to the configured OIDC provider for authentication.\n", "item": [ { "id": "ad3a4f4a-0c88-47e6-a5ec-21ee717e14de", "name": "Initiate OIDC Login", "request": { "name": "Initiate OIDC Login", "description": { "content": "Initiate the OIDC login flow for a specific store and authentication realm\n::: note This is not an **API Endpoint**, but the [Authentication Request](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest) of the OpenID Connect Authentication Flow.\nTo initiate an OpenID Connect authentication you must change the location in the Browser to this URL, not call it asynchronously. :::", "type": "text/plain" }, "url": { "path": [ "oidc-idp", "login", "stores", ":storeId", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The Client ID, for Account Management Authentication see the `meta.client_id` field on [Account Authentication Settings](/docs/api/accounts/get-v-2-settings-account-authentication).", "type": "text/plain" }, "key": "client_id", "value": "string" }, { "disabled": false, "description": { "content": "(Required) Redirection URI to which the response will be sent. Must exactly match a pre-registered redirect URI for the client in the `redirect_uris` of the [Authentication Realm](/docs/api/single-sign-on/get-v-2-authentication-realms-realm-id).", "type": "text/plain" }, "key": "redirect_uri", "value": "http://kFaPIFk.kfkrEBx,bOrW+IstRBh6.CkNXqwdhWOwdS,Z+bXwOhW0v5YufimEnOKtdatqBdf" }, { "disabled": false, "description": { "content": "(Required) OIDC/OAuth 2.0 response type, this must be \"code\" in Commerce.", "type": "text/plain" }, "key": "response_type", "value": "string" }, { "disabled": false, "description": { "content": "(Required) Space-delimited list of scopes. Must include \"openid\", \"email\", and \"name\".", "type": "text/plain" }, "key": "scope", "value": "string" }, { "disabled": false, "description": { "content": "(Required) Opaque value used to maintain state between the request and the callback. Helps prevent CSRF.", "type": "text/plain" }, "key": "state", "value": "string" }, { "disabled": false, "description": { "content": "(Required) [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636) transformation method that was used to derive code_challenge. (This can only be one of S256,plain)", "type": "text/plain" }, "key": "code_challenge_method", "value": "S256" }, { "disabled": false, "description": { "content": "(Required) [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636) Code Challenge.", "type": "text/plain" }, "key": "code_challenge", "value": "string" }, { "disabled": false, "description": { "content": "Space-delimited, case-sensitive list that specifies whether the Authorization Server prompts the End-User for re-authentication and consent. This value is passed to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).", "type": "text/plain" }, "key": "prompt", "value": "string" }, { "disabled": false, "description": { "content": "ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface. This value is passed to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).", "type": "text/plain" }, "key": "display", "value": "string" }, { "disabled": false, "description": { "content": "End-User's preferred languages and scripts for the user interface, represented as space-separated list of BCP47 language tag values. This value is forwarded to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).", "type": "text/plain" }, "key": "ui_locales", "value": "fr-CA fr en" }, { "disabled": false, "description": { "content": "(Required) Selects the specific OIDC Profile within the realm to use for authentication.", "type": "text/plain" }, "key": "elasticpath_commerce_cloud_profile_id", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5" }, { "disabled": false, "description": { "content": "Custom boolean flag. If true, if the user attempts to hit back in their browser, we will redirect them back to the store front", "type": "text/plain" }, "key": "ep_report_callback_replay_error", "value": "true" } ], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "storeId", "disabled": false, "description": { "content": "(Required) The ID of the store.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "78c89463-da90-4398-ab05-5bc8708ce5a0", "name": "See Other - Redirects to the IdP provider for authentication", "originalRequest": { "url": { "path": [ "oidc-idp", "login", "stores", ":storeId", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The Client ID, for Account Management Authentication see the `meta.client_id` field on [Account Authentication Settings](/docs/api/accounts/get-v-2-settings-account-authentication).", "type": "text/plain" }, "key": "client_id", "value": "string" }, { "disabled": false, "description": { "content": "(Required) Redirection URI to which the response will be sent. Must exactly match a pre-registered redirect URI for the client in the `redirect_uris` of the [Authentication Realm](/docs/api/single-sign-on/get-v-2-authentication-realms-realm-id).", "type": "text/plain" }, "key": "redirect_uri", "value": "http://kFaPIFk.kfkrEBx,bOrW+IstRBh6.CkNXqwdhWOwdS,Z+bXwOhW0v5YufimEnOKtdatqBdf" }, { "disabled": false, "description": { "content": "(Required) OIDC/OAuth 2.0 response type, this must be \"code\" in Commerce.", "type": "text/plain" }, "key": "response_type", "value": "string" }, { "disabled": false, "description": { "content": "(Required) Space-delimited list of scopes. Must include \"openid\", \"email\", and \"name\".", "type": "text/plain" }, "key": "scope", "value": "string" }, { "disabled": false, "description": { "content": "(Required) Opaque value used to maintain state between the request and the callback. Helps prevent CSRF.", "type": "text/plain" }, "key": "state", "value": "string" }, { "disabled": false, "description": { "content": "(Required) [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636) transformation method that was used to derive code_challenge. (This can only be one of S256,plain)", "type": "text/plain" }, "key": "code_challenge_method", "value": "S256" }, { "disabled": false, "description": { "content": "(Required) [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636) Code Challenge.", "type": "text/plain" }, "key": "code_challenge", "value": "string" }, { "disabled": false, "description": { "content": "Space-delimited, case-sensitive list that specifies whether the Authorization Server prompts the End-User for re-authentication and consent. This value is passed to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).", "type": "text/plain" }, "key": "prompt", "value": "string" }, { "disabled": false, "description": { "content": "ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface. This value is passed to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).", "type": "text/plain" }, "key": "display", "value": "string" }, { "disabled": false, "description": { "content": "End-User's preferred languages and scripts for the user interface, represented as space-separated list of BCP47 language tag values. This value is forwarded to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).", "type": "text/plain" }, "key": "ui_locales", "value": "fr-CA fr en" }, { "disabled": false, "description": { "content": "(Required) Selects the specific OIDC Profile within the realm to use for authentication.", "type": "text/plain" }, "key": "elasticpath_commerce_cloud_profile_id", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5" }, { "disabled": false, "description": { "content": "Custom boolean flag. If true, if the user attempts to hit back in their browser, we will redirect them back to the store front", "type": "text/plain" }, "key": "ep_report_callback_replay_error", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the store.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "storeId" }, { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "See Other", "code": 303, "header": [ { "disabled": false, "description": { "content": "The URL of the IdP provider to redirect to", "type": "text/plain" }, "key": "Location", "value": "http://kFaPIFk.kfkrEBx,bOrW+IstRBh6.CkNXqwdhWOwdS,Z+bXwOhW0v5YufimEnOKtdatqBdf" } ], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ace781c9-aef7-4d3c-a74c-2795697c3ddb", "name": "Temporary Redirect - Redirects the user back to the caller.", "originalRequest": { "url": { "path": [ "oidc-idp", "login", "stores", ":storeId", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The Client ID, for Account Management Authentication see the `meta.client_id` field on [Account Authentication Settings](/docs/api/accounts/get-v-2-settings-account-authentication).", "type": "text/plain" }, "key": "client_id", "value": "string" }, { "disabled": false, "description": { "content": "(Required) Redirection URI to which the response will be sent. Must exactly match a pre-registered redirect URI for the client in the `redirect_uris` of the [Authentication Realm](/docs/api/single-sign-on/get-v-2-authentication-realms-realm-id).", "type": "text/plain" }, "key": "redirect_uri", "value": "http://kFaPIFk.kfkrEBx,bOrW+IstRBh6.CkNXqwdhWOwdS,Z+bXwOhW0v5YufimEnOKtdatqBdf" }, { "disabled": false, "description": { "content": "(Required) OIDC/OAuth 2.0 response type, this must be \"code\" in Commerce.", "type": "text/plain" }, "key": "response_type", "value": "string" }, { "disabled": false, "description": { "content": "(Required) Space-delimited list of scopes. Must include \"openid\", \"email\", and \"name\".", "type": "text/plain" }, "key": "scope", "value": "string" }, { "disabled": false, "description": { "content": "(Required) Opaque value used to maintain state between the request and the callback. Helps prevent CSRF.", "type": "text/plain" }, "key": "state", "value": "string" }, { "disabled": false, "description": { "content": "(Required) [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636) transformation method that was used to derive code_challenge. (This can only be one of S256,plain)", "type": "text/plain" }, "key": "code_challenge_method", "value": "S256" }, { "disabled": false, "description": { "content": "(Required) [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636) Code Challenge.", "type": "text/plain" }, "key": "code_challenge", "value": "string" }, { "disabled": false, "description": { "content": "Space-delimited, case-sensitive list that specifies whether the Authorization Server prompts the End-User for re-authentication and consent. This value is passed to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).", "type": "text/plain" }, "key": "prompt", "value": "string" }, { "disabled": false, "description": { "content": "ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface. This value is passed to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).", "type": "text/plain" }, "key": "display", "value": "string" }, { "disabled": false, "description": { "content": "End-User's preferred languages and scripts for the user interface, represented as space-separated list of BCP47 language tag values. This value is forwarded to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).", "type": "text/plain" }, "key": "ui_locales", "value": "fr-CA fr en" }, { "disabled": false, "description": { "content": "(Required) Selects the specific OIDC Profile within the realm to use for authentication.", "type": "text/plain" }, "key": "elasticpath_commerce_cloud_profile_id", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5" }, { "disabled": false, "description": { "content": "Custom boolean flag. If true, if the user attempts to hit back in their browser, we will redirect them back to the store front", "type": "text/plain" }, "key": "ep_report_callback_replay_error", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the store.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "storeId" }, { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Temporary Redirect (since HTTP/1.1)", "code": 307, "header": [ { "disabled": false, "description": { "content": "The location to redirect to, typically the store front.", "type": "text/plain" }, "key": "Location", "value": "http://kFaPIFk.kfkrEBx,bOrW+IstRBh6.CkNXqwdhWOwdS,Z+bXwOhW0v5YufimEnOKtdatqBdf" } ], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "646441d0-4410-411a-96e9-300fbf4ca54d", "name": "In some cases the OAuth 2.0 specification does not permit us to redirect the user back to the caller, in which case they will see a 4xx.", "originalRequest": { "url": { "path": [ "oidc-idp", "login", "stores", ":storeId", "authentication-realms", ":realmId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The Client ID, for Account Management Authentication see the `meta.client_id` field on [Account Authentication Settings](/docs/api/accounts/get-v-2-settings-account-authentication).", "type": "text/plain" }, "key": "client_id", "value": "string" }, { "disabled": false, "description": { "content": "(Required) Redirection URI to which the response will be sent. Must exactly match a pre-registered redirect URI for the client in the `redirect_uris` of the [Authentication Realm](/docs/api/single-sign-on/get-v-2-authentication-realms-realm-id).", "type": "text/plain" }, "key": "redirect_uri", "value": "http://kFaPIFk.kfkrEBx,bOrW+IstRBh6.CkNXqwdhWOwdS,Z+bXwOhW0v5YufimEnOKtdatqBdf" }, { "disabled": false, "description": { "content": "(Required) OIDC/OAuth 2.0 response type, this must be \"code\" in Commerce.", "type": "text/plain" }, "key": "response_type", "value": "string" }, { "disabled": false, "description": { "content": "(Required) Space-delimited list of scopes. Must include \"openid\", \"email\", and \"name\".", "type": "text/plain" }, "key": "scope", "value": "string" }, { "disabled": false, "description": { "content": "(Required) Opaque value used to maintain state between the request and the callback. Helps prevent CSRF.", "type": "text/plain" }, "key": "state", "value": "string" }, { "disabled": false, "description": { "content": "(Required) [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636) transformation method that was used to derive code_challenge. (This can only be one of S256,plain)", "type": "text/plain" }, "key": "code_challenge_method", "value": "S256" }, { "disabled": false, "description": { "content": "(Required) [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636) Code Challenge.", "type": "text/plain" }, "key": "code_challenge", "value": "string" }, { "disabled": false, "description": { "content": "Space-delimited, case-sensitive list that specifies whether the Authorization Server prompts the End-User for re-authentication and consent. This value is passed to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).", "type": "text/plain" }, "key": "prompt", "value": "string" }, { "disabled": false, "description": { "content": "ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface. This value is passed to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).", "type": "text/plain" }, "key": "display", "value": "string" }, { "disabled": false, "description": { "content": "End-User's preferred languages and scripts for the user interface, represented as space-separated list of BCP47 language tag values. This value is forwarded to the configured IdP. See [Section 3.1.2.1. Authentication Request - OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).", "type": "text/plain" }, "key": "ui_locales", "value": "fr-CA fr en" }, { "disabled": false, "description": { "content": "(Required) Selects the specific OIDC Profile within the realm to use for authentication.", "type": "text/plain" }, "key": "elasticpath_commerce_cloud_profile_id", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5" }, { "disabled": false, "description": { "content": "Custom boolean flag. If true, if the user attempts to hit back in their browser, we will redirect them back to the store front", "type": "text/plain" }, "key": "ep_report_callback_replay_error", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the store.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "storeId" }, { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"invalid_request\",\n \"errorDescription\": \"The field [client_id] with value [unknownClient] is invalid.\",\n \"error_description\": \"The field [client_id] with value [unknownClient] is invalid.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29b93574-a131-4d68-b64b-91af6a59129e", "name": "OpenID Connect Discovery", "request": { "name": "OpenID Connect Discovery", "description": { "content": "Returns the OpenID Connect discovery document for the authentication realm.\nThis endpoint provides metadata about the OIDC provider's configuration, including endpoints, supported features, and capabilities. Some libraries might require an OIDC discovery document in order to work.\nFor more information see [OpenID Connect Discovery 1.0](https://openid.net/specs/openid-connect-discovery-1_0.html)", "type": "text/plain" }, "url": { "path": [ "oidc-idp", "stores", ":storeId", "authentication-realms", ":realmId", ".well-known", "openid-configuration" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The ID of the [OIDC profile](/docs/api/single-sign-on/oidc-profiles) that you would like to authenticate with", "type": "text/plain" }, "key": "elasticpath_commerce_cloud_profile_id", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5" } ], "variable": [ { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "storeId", "disabled": false, "description": { "content": "(Required) The ID of the store.", "type": "text/plain" } }, { "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId", "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5ce947fc-99df-43dc-94ed-e000a0952ad3", "name": "OK - OpenID Connect discovery document", "originalRequest": { "url": { "path": [ "oidc-idp", "stores", ":storeId", "authentication-realms", ":realmId", ".well-known", "openid-configuration" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The ID of the [OIDC profile](/docs/api/single-sign-on/oidc-profiles) that you would like to authenticate with", "type": "text/plain" }, "key": "elasticpath_commerce_cloud_profile_id", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the store.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "storeId" }, { "disabled": false, "description": { "content": "(Required) The ID of the authentication realm.", "type": "text/plain" }, "type": "any", "value": "c12f251b-e8dd-d60e-2935-45f5b2f38ec5", "key": "realmId" } ] }, "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 \"authorization_endpoint\": \"http://euwest.api.elasticpath.com/oidc-idp/login/stores/88888888-4444-4333-8333-111111111111/authentication-realms/45928070-44a6-448b-8246-a85aa35320af\",\n \"id_token_signing_alg_values_supported\": [\n \"RS256\"\n ],\n \"issuer\": \"http://euwest.api.elasticpath.com/oidc-idp/stores/88888888-4444-4333-8333-111111111111/authentication-realms/45928070-44a6-448b-8246-a85aa35320af\",\n \"jwks_uri\": \"http://euwest.api.elasticpath.com/oidc-idp/.well-known/jwks.json\",\n \"response_types_supported\": [\n \"code\"\n ],\n \"scopes_supported\": [\n \"profile\",\n \"openid\",\n \"email\"\n ],\n \"subject_types_supported\": [\n \"public\"\n ],\n \"token_endpoint\": \"http://euwest.api.elasticpath.com/oidc-idp/token/stores/88888888-4444-4333-8333-111111111111/authentication-realms/45928070-44a6-448b-8246-a85aa35320af\",\n \"token_endpoint_auth_methods_supported\": \"client_secret_basic\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Features", "description": "A feature indicates some benefit that is received as a result of having an active subscription. This translates to tags being applied to the subscriber's account allowing access to some resource to be controlled.\n\nThere are three types of feature - `access`, `promotion`, and `usage`.\n\nThe `access` feature is designed to simply give access to some resource, for example a streaming service. If its tag is present on the subscriber's account then access to that resource should be provided.\n\nThe `promotion` feature coupled with the [promotions service](/docs/promotions-builder/overview) allows subscribers to get access to a specific promotion. This is achieved using a tag which is used as a constraint on the promotion. A promotion feature may have multiple promotions associated with it, but just one must be selected when configuring the feature for an offering's plan.\n\n The `usage` feature is designed to measure some sort of usage of a resource. This currently relies on [commerce extensions](/docs/api/commerce-extensions/commerce-extensions-introduction) to manage usage.\n\n Once defined a feature may be attached to an offering, making it available for use with any of that offering's plans. Once attached it must be configured for each of the offering's plans it is applicable to. For the `promotion` feature this involves specifying which of that feature's tags, and hence which promotion, should be applied when subscribed to that offering. Similarly, for the `promotion` feature the default value for the usage metric must be supplied.\n", "item": [ { "id": "703cd03b-33bb-4762-975d-3c7239874fce", "name": "Create a feature", "request": { "name": "Create a feature", "description": {}, "url": { "path": [ "v2", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4c91a3d4-0886-43eb-9b5f-31cc979b9096", "name": "Success. The feature is created.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41ef0ad1-24a2-4853-8bfd-2446bd233d71", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "173bb171-61fc-4d86-aad8-e5fde09e7935", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba97bbcc-7921-43a9-937c-9c8583946d77", "name": "List features", "request": { "name": "List features", "description": { "content": "Retrieves a list of all subscription features.\n\n### Filtering\n\nThis endpoint supports filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description |\n| --- | --- | --- | \n| `eq` | `external_ref` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |\n| `eq` | `tag` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |\n| `in` | `external_ref`, `tag` | In. Checks if the value is in the specified list. If it is, the condition is true. |\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4bc3803a-42ea-409a-8096-66220c9915d0", "name": "Success. A list of features is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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 \"type\": \"subscription_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"type\": \"subscription_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0be28c12-365b-420d-8e3c-8e392a8917f8", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d391ace5-efbb-4b1f-af5e-c9e8b5b9621d", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c863d5c-9b07-4b64-852b-827fab388d7c", "name": "Get feature", "request": { "name": "Get feature", "description": {}, "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "404c54fa-2b0f-4073-9b3e-36a4ac512a4e", "name": "Success. The feature details are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"type\": \"subscription_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7efe9727-1a33-4703-9334-8db2dff0ad4e", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88ec08ac-0967-457d-af16-2a304c855e2a", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48975d46-ea9f-42d3-a59f-7afdc7c91c36", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c62c0d29-2db4-4eb5-bafb-bb6b68de9518", "name": "Delete feature", "request": { "name": "Delete feature", "description": { "content": "Remove a feature.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "c277ef21-d272-4a75-a7ec-c9e9e770ec37", "name": "Success. The feature is removed.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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": "22ce38b0-64d3-4763-86be-d3e45c9e4f1d", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "635d4d46-0082-4423-b2c8-97ca56c67171", "name": "Update a feature", "request": { "name": "Update a feature", "description": { "content": "Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the feature is not updated. For fields that are optional, an existing value can be removed by specifying a value of null.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "cdc7fce6-b768-439f-a533-4760157354b2", "name": "Success. The feature details are updated.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\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 \"type\": \"subscription_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e74981dd-9176-4df3-9430-f9ff966ae21b", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0c29dd4-fa0f-483c-bdf6-15d34d7c6682", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab9aeea4-d26f-4d02-ad6a-650821818c3a", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eefd645f-c3a9-40f4-aafe-f9fc6f60cbdf", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "411da128-54a0-4006-98e4-3418f8d39d81", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Offerings", "description": "An offering is a combination of plans and pricing options; plans are combined with one or more pricing options to form an offering. \n\nFor example, your company provides online\n streaming of movies, web-series, and music. Your customers can purchase these services through either a weekly or monthly pricing option.\n\nOffering plans can be either:\n\n- a subscription plan, created within an offering.\n- a Product Experience Manager product, see [**Create a product**](/docs/api/pxm/products/create-product)\n\n### Offering Examples\n\nOfferings can have any combination of plans and pricing options. The pricing of an offering is determined by the pricing you have configured for your plans and pricing options.\n\n| Example | Plan | Pricing options | Offering |\n| --- | --- | --- | --- |\n| Single plan and pricing option | One plan with a plan price of $50 | A monthly pricing option with a 5% discount | An offering with a monthly pricing option for $47.50 a month |\n| Single plan with multiple pricing options | One plan with a plan price of $50 |
  • A monthly pricing option with a 5% discount
  • A yearly pricing option with a 10% discount
| An offering with two pricing options:
  • A monthly pricing option for $47.50 a month
  • A yearly pricing option for $45 a month
|\n| Multiple plans and pricing option | Two plans:
  • One plan with a plan price of $50.
  • One plan with a plan price of $75.
| A monthly pricing option with a 5% discount. | An offering with a monthly pricing option for $118.75 a month. | \n| Multiple plans with multiple pricing options | Two plans:
  • One plan with a plan price of $50.
  • One plan with a plan price of $75.
|
  • A monthly pricing option with a 5% discount
  • A yearly pricing option with a 10% discount
| An offering with two pricing options:
  • A monthly pricing option for $118.75 a month
  • A yearly pricing option for $112.50 a month
| \n\n### Building an Offering\n\nWhen you are building an offering:\n\n- you can create new pricing options and plans.\n- you can modify existing plans and pricing options. For example, you can modify the plan price or any attributes of a pricing option included in the offering.\n\nHere's how you build an offering:\n\nWhen [**building your offerings**](/docs/api/subscriptions/build-offering) you must supply the plans and pricing options that a customer can choose. An offering can consist of many combinations of a plan or pricing options, depending on the plans and services you offer.\n\nPlans can either be subscription plans or Product Experience Manager products. To create a Product Experience Manager product, see [**Create a product**](/docs/api/pxm/products/create-product)\n\nPricing options are the rules that govern your subscription, for example, any discount. \n - You can combine and reuse pricing options for as many plans as you want, making it quick and easy to create your subscription offerings. \n - An offering must have at least one pricing option.\n - Each plan must have the appropriate pricing option associated with it\n\nWhen a [**customer**](/docs/api/subscriptions/subscribers) chooses a plan and pricing option, a subscription is created. See [**Subscriptions**](/docs/api/subscriptions/subscriptions). Elastic Path Subscriptions manages the billing and recurring payments associated with the subscription. See [**Invoicing and Billing**](/docs/api/subscriptions/jobs).\n\n### Editing Offerings\n\nAfter saving an offering, you can, at any time:\n\n- update an offering's details, for example, name or description. See [**Update an Offering**](/docs/api/subscriptions/update-offering).\n- update an existing plan in an offering. See [**Update a plan in an offering**](/docs/api/subscriptions/update-offering-plan)\n- add a new plan in an offering. See [**Create a plan inside an offering**](/docs/api/subscriptions/create-offering-plan)\n- remove plans. See [**Remove a plan from an offering**](/docs/api/subscriptions/delete-offering-plan).\n- update an existing pricing option in an offering. See [**Update a pricing option in an offering**](/docs/api/subscriptions/update-offering-pricing-option)\n- add a new pricing option to an offering. See [**Create a pricing option inside an offering**](/docs/api/subscriptions/create-offering-pricing-option).\n- remove pricing options. See [**Removing a pricing option from an offering**](/docs/api/subscriptions/delete-offering-plan).\n\nAny modifications that you make to offerings, and plans or pricing options in an offering, does not affect any active subscriptions. The changes take effect on all new subscriptions that are created.\n", "item": [ { "id": "241477c4-befc-4b1b-bcc1-20b80d170b00", "name": "Create an offering", "request": { "name": "Create an offering", "description": {}, "url": { "path": [ "v2", "subscriptions", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering\",\n \"attributes\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"relationships\": {\n \"proration_policy\": {\n \"type\": \"subscription_proration_policy\",\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f7e1e56e-9155-4589-a08e-b0d54c7d231b", "name": "Success. The offering is created.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering\",\n \"attributes\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"relationships\": {\n \"proration_policy\": {\n \"type\": \"subscription_proration_policy\",\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_offering\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"external_plan_refs\": [\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\",\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dee2cdd4-5210-42b2-a373-3ba2505dfca1", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering\",\n \"attributes\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"relationships\": {\n \"proration_policy\": {\n \"type\": \"subscription_proration_policy\",\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e1ddfe9-aa53-42c5-9454-afaa293dea2c", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering\",\n \"attributes\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"relationships\": {\n \"proration_policy\": {\n \"type\": \"subscription_proration_policy\",\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1b2c823-2eca-49ad-98c8-e7734353090d", "name": "List offerings", "request": { "name": "List offerings", "description": { "content": "Retrieves a list of all subscription offerings.\n\n### Filtering\n\nThis endpoint supports filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description |\n| --- | --- | --- | \n| `eq` | `external_ref`, `plans.external_ref`, `proration_policy_id` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |\n| `in` | `external_ref`, `plans.external_ref`, `proration_policy_id` | In. Checks if the value is in the specified list. If it is, the condition is true. |\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "655f26af-daae-40f0-9e4a-0939bef6240c", "name": "Success. A list of offerings is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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 \"type\": \"subscription_offering\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"external_plan_refs\": [\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\",\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"external_plan_refs\": [\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\",\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"included\": {\n \"features\": [\n {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"plans\": [\n {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"pricing_options\": [\n {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_2\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c91f6b12-cedb-45cc-9ade-f8b7b37dec99", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa3ef08d-f1c7-47dc-8b60-710cdace1ff7", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bdc6e075-4d03-4c11-ae8f-9cbbde1a9448", "name": "Build an offering", "request": { "name": "Build an offering", "description": { "content": "An offering includes plans and pricing options; plans are combined with one or more pricing options to form an offering. An offering can include either:\n\n- subscription plans (created within an offering).\n- Product Experience Manager products. See [**create a product**](/docs/api/pxm/products/create-product).\n\nWhen you are building an offering:\n\n- you can create new pricing options and plans.\n- you can modify an existing plan and pricing options. For example, you can modify the plan price or any attributes of a pricing option included in the offering.\n\nHere's how you build an offering:\n\n1. Specify the plan to build with the offering. A plan can be:\n\n - subscription plans. Specify the subscription plan attributes. \n - Product Experience Manager products. Specify the Product Experience Manager product ID in `external_ref` in `PlanAttributes`. For the remaining plan attributes, you can specify their values to match the values of the existing Product Experience Manager product attributes. However, you can also specify different values, depending on your requirements.\n\n2. Specify the pricing options to build with the offering. Pricing options are the rules that govern your subscription, for example, any discount. You can combine and reuse pricing options for as many plans as you want, making it quick and easy to create your subscription offerings.\n An offering must have at least one pricing option. \n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", "build" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"name\": \"Magazine\",\n \"plans\": [\n {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n },\n \"key_2\": {\n \"type\": \"access\"\n }\n }\n }\n ],\n \"pricing_options\": [\n {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n ],\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"configured_features\": {\n \"key_0\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"key_1\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n },\n \"key_2\": {\n \"type\": \"access\"\n }\n }\n },\n \"pricing_option_associations\": {\n \"key_0\": [\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n ],\n \"key_1\": [\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"features\": [\n \"abc123\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "77aebbf8-a1e8-4ac5-afb5-bfc3cbf23e3a", "name": "Success. The new subscription offering is created with the specified subscription plans and pricing options attached to the offering.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", "build" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"name\": \"Magazine\",\n \"plans\": [\n {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n },\n \"key_2\": {\n \"type\": \"access\"\n }\n }\n }\n ],\n \"pricing_options\": [\n {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n ],\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"configured_features\": {\n \"key_0\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"key_1\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n },\n \"key_2\": {\n \"type\": \"access\"\n }\n }\n },\n \"pricing_option_associations\": {\n \"key_0\": [\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n ],\n \"key_1\": [\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"features\": [\n \"abc123\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_offering\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"external_plan_refs\": [\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\",\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1b64934-a526-4635-b354-2cd7a28b4af9", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", "build" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"name\": \"Magazine\",\n \"plans\": [\n {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n },\n \"key_2\": {\n \"type\": \"access\"\n }\n }\n }\n ],\n \"pricing_options\": [\n {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n ],\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"configured_features\": {\n \"key_0\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"key_1\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n },\n \"key_2\": {\n \"type\": \"access\"\n }\n }\n },\n \"pricing_option_associations\": {\n \"key_0\": [\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n ],\n \"key_1\": [\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"features\": [\n \"abc123\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66254c38-6067-4ee4-8c68-4dcf70068d8a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", "build" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"name\": \"Magazine\",\n \"plans\": [\n {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n },\n \"key_2\": {\n \"type\": \"access\"\n }\n }\n }\n ],\n \"pricing_options\": [\n {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n ],\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"configured_features\": {\n \"key_0\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"key_1\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n },\n \"key_2\": {\n \"type\": \"access\"\n }\n }\n },\n \"pricing_option_associations\": {\n \"key_0\": [\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n ],\n \"key_1\": [\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"features\": [\n \"abc123\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "454084ab-7d8c-4b18-87c3-c883c1ec8333", "name": "Get offering", "request": { "name": "Get offering", "description": {}, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" } ], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d8e7fadb-2bc7-48c0-ac34-ad598c42d7dc", "name": "Success. The details of the subscription offering are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"type\": \"subscription_offering\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"external_plan_refs\": [\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\",\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n \"included\": {\n \"features\": [\n {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_3\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"plans\": [\n {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"pricing_options\": [\n {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a68a3574-1c69-415e-92ea-0a565add165c", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7d5aff1-f305-4568-87b7-71b004b99c63", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b81d8752-ca35-4c1c-a6b0-6535eb4311a5", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2f747bc-0f01-43d2-9498-17771770413a", "name": "Delete offering", "request": { "name": "Delete offering", "description": { "content": "When a subscription is created, it creates a snapshot of the offering. This means you can delete an offering without affecting any active subscriptions.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "32bafaa7-a262-440e-9300-867099cde80c", "name": "Success. The subscription offering is removed.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "c6c05f3e-3120-4862-9964-79593b35711d", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "882a1723-0a15-4be1-8aab-c985cf6a3531", "name": "Update an offering", "request": { "name": "Update an offering", "description": { "content": "After saving an offering, you can update an offering at any time. Updating an offering does not affect any active subscriptions. The changes take effect on all new subscriptions that are created. For fields that are optional, an existing value can be removed by specifying a value of null.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"attributes\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bdf7dce5-7e46-4541-bb5b-067be88dd74b", "name": "Success. The details of the subscription offering are updated.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"data\": {\n \"attributes\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_offering\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"external_plan_refs\": [\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\",\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02747e47-f1b6-4f5f-adad-1b1e60a89033", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"data\": {\n \"attributes\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19ebeb0e-1590-4d6e-bf9f-d3109e009744", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"data\": {\n \"attributes\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93d8ca56-9a64-4857-a42b-6127594fb528", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"data\": {\n \"attributes\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0454ca26-a020-4a2b-8170-a8cfc7e27cb6", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"data\": {\n \"attributes\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40e42deb-533f-4586-8935-eaa926c843a4", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"data\": {\n \"attributes\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bea7d459-e01b-4f9a-93c8-3879322ea905", "name": "Get a feature in an offering", "request": { "name": "Get a feature in an offering", "description": {}, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "80c8b814-a056-462c-b905-048bd66b0952", "name": "Success. The details of the feature are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17bd356d-52dd-434a-b7e7-61a5df51b94e", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8cd2a02-3bb6-4954-8ab9-646e3f55559d", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a4f445b-0ca3-47a8-9aad-16118f543823", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0aabf66-25aa-4a7c-8050-364c1d35442f", "name": "Updates a feature in an offering", "request": { "name": "Updates a feature in an offering", "description": { "content": "Use the unique identifier of the feature in the offering that you want to update. Any modifications that you make to the features in an offering, does not affect any active subscriptions. The changes take effect on all new subscriptions that are created.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "dbffdeb1-738d-48dc-95fb-f818611b95fb", "name": "Success. The feature details are updated on the offering.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\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 \"type\": \"subscription_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed2d8a72-1755-4f4f-b992-4f5d5852c6e8", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "795d9e4c-d347-4128-9c69-bd655479a174", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55b0685a-90a5-472e-b53c-98508c931170", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eea8f919-e8ea-4d39-8ed2-cf383f4dbf66", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "feecb181-5162-4d2d-944f-ac917ed102b1", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Digital library access\",\n \"description\": \"Access to over 100 ebooks via the digital library.\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2dc23fcd-fcb2-4ba4-a2da-7985b1b51068", "name": "Remove a feature from an offering", "request": { "name": "Remove a feature from an offering", "description": { "content": "After saving an offering, you can remove features from it at any time.\n\n Removing a feature from an offering does not affect any existing active subscriptions. The changes take effect on all new subscriptions that are created.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "5d637f4c-e4cf-49f6-aa69-7fb35b66003d", "name": "Success. The subscription feature is removed from the offering.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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": "a1b3c4f3-28bd-424a-86d9-ac32848c6e28", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fabbdf6-edd0-4be7-9baa-ecf01aeed433", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac1c1d56-b925-414e-812b-4af948b684e6", "name": "Attach a feature", "request": { "name": "Attach a feature", "description": { "content": "After saving an offering, you can attach new features to it at any time.\n\nAdding new features does not affect any existing active subscriptions. The changes take effect on all new subscriptions that are created.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"features\": [\n \"11111111-2222-3333-4444-555555555555\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d0090a6f-e195-456e-ac2e-c887b4706fbc", "name": "Success. The subscription feature is attached with the offering.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"features\": [\n \"11111111-2222-3333-4444-555555555555\"\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 \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45b73441-31b5-4524-b8ed-5f3b8dc85c94", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"features\": [\n \"11111111-2222-3333-4444-555555555555\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d665fbb7-dbb9-4af2-8f39-cafc11e8656c", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"features\": [\n \"11111111-2222-3333-4444-555555555555\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3b000d9-c1fe-4605-b61e-bd1481818e43", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"features\": [\n \"11111111-2222-3333-4444-555555555555\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4333bc84-af69-47ff-acc9-a722bfc86f3b", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"features\": [\n \"11111111-2222-3333-4444-555555555555\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fdccddd-90ee-452a-8bd1-fd3047948df1", "name": "List an offering's pricing options", "request": { "name": "List an offering's pricing options", "description": {}, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3c5d7503-ac08-4a5f-a9ad-141a32bf648c", "name": "Success. A list of pricing options attached with the offering is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_3\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b80f2a1f-142e-4782-816d-82a56669b585", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06b43d15-bcca-4cb5-b031-b5f487d0fcb6", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fbd4108f-1260-425f-94ed-0f929f652525", "name": "Create a pricing option inside an offering", "request": { "name": "Create a pricing option inside an offering", "description": { "content": "After saving an offering, you can add new pricing option to it at any time.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "950927fd-785e-4410-9a66-22e4b40b555f", "name": "Success. The pricing option is created.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_2\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38ab3b52-489e-4479-b308-e617778090ee", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4151b4ec-55d9-4f82-b4a3-41bc50b1329d", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9363763c-93de-4041-b876-63553c51e815", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a30a72b-946d-4b1e-86b9-4dcaa12b26d2", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0169be7a-de4e-4c0d-a1ef-80c1390e240f", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e93e908b-5707-48bc-945e-7a13767776c1", "name": "Get a pricing option in an offering", "request": { "name": "Get a pricing option in an offering", "description": {}, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "64b21c70-2c84-4e98-8a00-e32dac278a06", "name": "Success. The details of the pricing option are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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 \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_2\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "248a4f3c-00ac-4498-b0c4-65d3fdcbc45a", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b037b60f-a369-41a5-9aee-f40923c6bf8f", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2a7b21d-12a6-4fdb-9e07-0bcbc54a7875", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e89ef45e-9f8c-434b-a32e-d00abfae8958", "name": "Update a pricing option in an offering", "request": { "name": "Update a pricing option in an offering", "description": {}, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Monthly\",\n \"description\": \"A monthly subscription.\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"trial_period\": 7,\n \"plan_length\": 12,\n \"lead_time\": {\n \"type\": \"week\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ff05d4e3-9c1e-45ee-95fb-ade84c9fa525", "name": "Success. The pricing option details are updated on the offering.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Monthly\",\n \"description\": \"A monthly subscription.\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"trial_period\": 7,\n \"plan_length\": 12,\n \"lead_time\": {\n \"type\": \"week\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\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 \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_2\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bba161a6-3113-4aee-b199-0559bf77b817", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Monthly\",\n \"description\": \"A monthly subscription.\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"trial_period\": 7,\n \"plan_length\": 12,\n \"lead_time\": {\n \"type\": \"week\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e285356f-b7d4-447e-90fc-37188e470bc0", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Monthly\",\n \"description\": \"A monthly subscription.\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"trial_period\": 7,\n \"plan_length\": 12,\n \"lead_time\": {\n \"type\": \"week\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fab38894-3a3d-4ef8-8166-59a0e55d8159", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Monthly\",\n \"description\": \"A monthly subscription.\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"trial_period\": 7,\n \"plan_length\": 12,\n \"lead_time\": {\n \"type\": \"week\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1827d03-3341-48bd-83ee-e1680637e6c3", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Monthly\",\n \"description\": \"A monthly subscription.\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"trial_period\": 7,\n \"plan_length\": 12,\n \"lead_time\": {\n \"type\": \"week\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d32b34e-577f-4a37-970c-12859d4dc283", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Monthly\",\n \"description\": \"A monthly subscription.\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"trial_period\": 7,\n \"plan_length\": 12,\n \"lead_time\": {\n \"type\": \"week\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0651f22a-12fb-41ac-9c68-b8d851e56f2b", "name": "Remove a pricing option from an offering", "request": { "name": "Remove a pricing option from an offering", "description": { "content": "After saving an offering, you can remove pricing options from it at any time.\n\nRemoving a pricing option from an offering does not affect any existing active subscriptions. The changes take effect on all new subscriptions that are created.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "f346cf99-d31d-437b-8f4c-bdde20bff7ed", "name": "Success. The subscription pricing option is no longer associated with the offering.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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": "466dae52-0bc2-45db-9ab0-21ae71496f9d", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e20515f4-e8d9-4cf2-a738-b15092d5f421", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2884f1d-dc83-4226-b1be-9e11a80db4c1", "name": "List an offering's features", "request": { "name": "List an offering's features", "description": {}, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "99a8e638-478c-4726-b117-39ac2ab3d2ed", "name": "Success. A list of subscription features attached to the offering is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90c7c01f-ce52-4e6b-9e90-23e16e5150e7", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8af37f8-b002-4b95-a517-931bac4b5dbe", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "440a841d-7345-4a88-9137-f70d717ddaf9", "name": "Create a feature directly inside an offering", "request": { "name": "Create a feature directly inside an offering", "description": { "content": "After saving an offering, you can add new features to it at any time.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a7a2cd00-e9f8-4117-9b3c-85de618397cb", "name": "Success. The feature is created.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1f44192-285a-4f58-94e9-f3a9d72ebed7", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f123ce3-68d7-4a6e-a2fd-dab3cca20608", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afe6ab6d-55e0-45e1-adbe-751f2fcc6afc", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "425991ea-55e4-4f77-8697-e6683810efda", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92f06fcc-7c11-48ef-91f8-61cf4a004643", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16853d8d-9393-402f-a7f4-796ef74e9743", "name": "List an offering's plans", "request": { "name": "List an offering's plans", "description": {}, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e46152ab-2e23-4879-8194-32fb5ddfdeb5", "name": "Success. A list of subscription plans attached to the offering is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n },\n \"key_2\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_3\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_4\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n },\n \"key_2\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31f1b6dc-7ab8-437f-84d4-668a7fbaf538", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e40274e-48eb-4590-9cf7-a5d645dd8d7c", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b98b2eb-cd51-4a86-9289-ab0836ec7746", "name": "Create a plan inside an offering", "request": { "name": "Create a plan inside an offering", "description": { "content": "After saving an offering, you can add new plans to it at any time.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n },\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "248cbd67-540f-4956-86bf-5ebe4f83c6a1", "name": "Success. The plan is created.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n },\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_2\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb342462-3b87-4368-b453-496d4dea556e", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n },\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0839e86f-12be-4d76-9ee5-38259ef1960d", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n },\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "741ab30e-3053-49d5-8304-c0cb9ef9fa2a", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n },\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38511746-fed4-44ce-a16d-f2747fe2c903", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n },\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7e0835a-f100-43c6-a5ef-8ae37111af60", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n },\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f55ceeb6-62cb-4b48-bcc8-d331d0d34362", "name": "Get a plan in an offering", "request": { "name": "Get a plan in an offering", "description": {}, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "60821bb1-06d6-4100-98fe-61b4d7d5e792", "name": "Success. The details of the plan are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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 \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_2\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f7b57be-a1e0-479f-bb63-a0ca61839abb", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c48d34d1-a68d-4f6e-bf37-6e59dbf91605", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a50986a-c4fe-4c6e-bf69-7475dc9ef005", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7fc45b75-4d67-41fe-aa81-b8ad4d2ce077", "name": "Update a plan in an offering", "request": { "name": "Update a plan in an offering", "description": { "content": "Use the unique identifier of the plan in the offering that you want to update. Any modifications that you make to the plans in an offering, does not affect any active subscriptions. The changes take effect on all new subscriptions that are created.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Magazine\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f4dbcc92-d53a-4963-a049-61f90da69d16", "name": "Success. The plan details are updated on the offering.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Magazine\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\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 \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_2\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41f2c765-ac03-47fa-9373-34776a37a2bc", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Magazine\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e56837c5-e962-4fe2-8e11-bfe46ae154f5", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Magazine\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad9fd16f-16a4-4424-8a83-74382416834e", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Magazine\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6081b19c-0e84-4038-874b-74041c49c239", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Magazine\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6f4445a-44e9-4922-897a-32c83c0ac5d3", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Magazine\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06f102d8-af03-4639-a0da-151cafc01500", "name": "Remove a plan from an offering", "request": { "name": "Remove a plan from an offering", "description": { "content": "After saving an offering, you can remove plans from it at any time.\n\n Removing a plan from an offering does not affect any existing active subscriptions. The changes take effect on all new subscriptions that are created.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "3f8be7d2-1d45-44bf-b018-f46ee7710527", "name": "Success. The subscription plan is removed from the offering.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "34e40a67-1a66-47e2-9daa-de1ce7abd76c", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b39edcb-18f3-4fef-985e-173608a2cfa5", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05da5aa9-9f1a-4392-a946-4615efdfa674", "name": "List the pricing options available to a plan in an offering", "request": { "name": "List the pricing options available to a plan in an offering", "description": {}, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "73cee7a8-4242-4e98-83d7-6647348fd995", "name": "Success. The pricing option relationships are returned", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9694938-749b-467f-9f9e-c3436c88ec0d", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c406ff7-a559-4d7f-b94f-9d032b7e210b", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8ea45d7-deae-426e-abb1-fb040460641e", "name": "Adds an offering's pricing options to the plan", "request": { "name": "Adds an offering's pricing options to the plan", "description": { "content": "Use the unique identifier of the pricing in the offering that you want to update. Any modifications that you make to the plans in an offering, does not affect any active subscriptions. The changes take effect on all new subscriptions that are created.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "139e1355-1454-4ac2-a4cc-679aae57cc2a", "name": "Success. The pricing options are added to the plan", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\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\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a694c62b-3663-4606-a65d-eb0fd7ff65f4", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df651fdc-5cda-45b8-9f82-b714fd8b271e", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f7faf25-eeb2-4643-a911-7e155f73d02b", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67efff4d-dcca-4e8d-b531-21c736838d4a", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03c59dc2-671e-41ed-9de0-0d1eadb911a5", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e12c36fd-0e05-4ba8-a33a-e6b0ea9dbceb", "name": "Removes an offering's pricing options from the plan", "request": { "name": "Removes an offering's pricing options from the plan", "description": { "content": "Use the unique identifier of the pricing in the offering that you want to update. Any modifications that you make to the plans in an offering, does not affect any active subscriptions. The changes take effect on all new subscriptions that are created.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9e4b2221-78d4-4fba-a717-e0ef02bd208d", "name": "Success. The pricing options are added to the plan", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\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\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1970e1d-47d8-4711-aefc-4a2f06554df1", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "891ac43e-d7df-4f7f-ade1-2e1c1b309268", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d1411f5-0727-4d4d-b33e-e71a1a5e2941", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9c7d15e-055f-4dff-b7c6-2d92e84ddb5d", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d53a4c8f-3a25-4080-93d1-80d3c48aecca", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "offerings", ":offering_uuid", "plans", ":plan_uuid", "relationships", "pricing_options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the offering.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "offering_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "DELETE", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Subscriptions", "description": "Elastic Path Subscriptions enables you to manage your subscriptions plans and pricing options, using offerings. Offerings can contain any combination of pricing options and a plan. When a customer chooses a pricing option, a subscription is created. \n\n### Managing the Subscription Lifecycle\n\nThe subscription lifecycle is the states that a subscription can go through when a customer subscribes to a service or a plan. \n\nA subscription can have the following states:\n\n- `pending`\n- `canceled`\n- `paused`\n- `resumed`\n\n#### Creating a pending subscription \n\nA subscription can be created in a `pending` state. This is useful for several reasons.\n\n- If there are subscriptions that require user setup or onboarding, for example, installing software or setting up preferences. This helps reduce shopper frustration during the onboarding process, as the shopper is not paying for a service that they cannot use yet.\n- When offering a free trial or promotion, keeping the subscription in a pending state until the trial or promotion starts or ends allows you to manage transitions more smoothly. \n- Before a subscription becomes active, you may need to verify the payment method or authorize the first payment. Keeping the subscription in a pending state allows time to complete these steps without activating the subscription.\n\nFor a subscription with a `pending` state, you can also configure a `go_live_after` date. The subscription starts from the `go_live_after` date. This is useful as it ensures both the subscription provider and subscriber are clear about when a subscription officially begins. Once the `go_live_after` date is passed, the subscription becomes `active`, initiating the billing and payment runs. If a subscription is activated this way, you can see this in the `timestamp` meta. \n\nYou can configure a `go_live_after` date to be a past date. This is useful, for example, for backdating a subscription or managing a delay in activating a subscription. Setting the `go_live_after` date in the past ensures the subscriptions timeline correctly aligns with the agreed-upon service start date. \n\n:::caution\n\nAlthough, billing runs generate one invoice per subscription, if a `go_live_date` is set far in the past, multiple invoices could be generated over the course of several billing runs, which could be frustrating and confusing to your subscribers. \n\n:::\n\nSee [create a subscription](/docs/api/subscriptions/create-subscription).\n\n#### Cancelling or pausing and resuming subscriptions\n\nA subscriber can decide to cancel or pause and/or resume a subscription. The following example describes pausing or canceling and resuming a subscription.\n\n1. The subscriber pauses or cancels the subscription. \n - The subscription status is `active`. \n - either `paused` or `cancelled` is set to `true`.\n - either the `paused_at` or `cancelled_at` timestamp is populated with the date and time the subscription is paused or cancelled.\n - for cancelled subscriptions, `end_date` indicates when the subscription will expire and end.\n2. When the next billing run is due, the billing run checks the subscription state. If the subscription state is paused or cancelled then no invoice is created and the subscription status is updated to `inactive`.\n3. Subsequent billing runs skip that subscription completely as the subscription status is `inactive`.\n4. If the subscriber resumes the subscription:\n - either `paused` or `cancelled` is set to `false`.\n - the `resumed_at` timestamp is populated with the date and time the subscription is resumed.\n5. When the next billing run is due, the billing run checks the subscription state. If the `paused` or `cancelled` is set to `false` then the billing run creates an invoice.\n6. The payment run processes the invoice. Once the payment succeeds then the payment run updates the status of the subscription to `active`.\n\n### Orders\n\nWhen a customer chooses a subscription, they need to add the subscription to a cart, checkout the cart and then pay for the order. \n\n1. When a customer adds a subscription to cart, this is handled using the `Add subscription to cart` endpoint. \n2. Once a subscription has been added to a cart, the [**Checkout API**](/docs/api/carts/checkout-api) converts the cart to an order. \n3. Once the order is created, payment needs to be taken. This is handled by Elastic Path Payments Powered by Stripe. See [**Payments**](/docs/api/subscriptions/invoices#payments).\n", "item": [ { "id": "7bfd17b7-c965-4d04-b07d-360c232e3f40", "name": "Create a subscription", "request": { "name": "Create a subscription", "description": {}, "url": { "path": [ "v2", "subscriptions", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"currency\": \"USD\",\n \"name\": \"Albert Einstein\",\n \"email\": \"albert@elasticpath.com\",\n \"manual_payments\": false,\n \"external_ref\": \"abc123\",\n \"address_id\": \"11111111-2222-3333-4444-555555555555\",\n \"offering_external_ref\": \"abc123\",\n \"offering_id\": \"11111111-2222-3333-4444-555555555555\",\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"pricing_option_id\": \"11111111-2222-3333-4444-555555555555\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n },\n \"pending\": false,\n \"first_invoice_paid\": false,\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"override_first_period_end_date\": \"2027-02-01T00:00:00Z\",\n \"offering\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"features\": [\n \"abc123\"\n ],\n \"plans\": [\n {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"meta\": {\n \"selected\": true\n }\n }\n ],\n \"pricing_options\": [\n {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"meta\": {\n \"selected\": true\n }\n }\n ],\n \"configured_features\": {\n \"key_0\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"key_1\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"key_2\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n },\n \"pricing_option_associations\": {\n \"key_0\": [\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"selected_plan\": \"abc123\",\n \"selected_pricing_option\": \"abc123\",\n \"order\": {\n \"order_id\": \"11111111-2222-3333-4444-555555555555\",\n \"order_item_id\": \"11111111-2222-3333-4444-555555555555\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "53b3db30-c8a6-4ff5-9452-01303b8289f2", "name": "Success. The subscription is created.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"currency\": \"USD\",\n \"name\": \"Albert Einstein\",\n \"email\": \"albert@elasticpath.com\",\n \"manual_payments\": false,\n \"external_ref\": \"abc123\",\n \"address_id\": \"11111111-2222-3333-4444-555555555555\",\n \"offering_external_ref\": \"abc123\",\n \"offering_id\": \"11111111-2222-3333-4444-555555555555\",\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"pricing_option_id\": \"11111111-2222-3333-4444-555555555555\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n },\n \"pending\": false,\n \"first_invoice_paid\": false,\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"override_first_period_end_date\": \"2027-02-01T00:00:00Z\",\n \"offering\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"features\": [\n \"abc123\"\n ],\n \"plans\": [\n {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"meta\": {\n \"selected\": true\n }\n }\n ],\n \"pricing_options\": [\n {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"meta\": {\n \"selected\": true\n }\n }\n ],\n \"configured_features\": {\n \"key_0\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"key_1\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"key_2\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n },\n \"pricing_option_associations\": {\n \"key_0\": [\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"selected_plan\": \"abc123\",\n \"selected_pricing_option\": \"abc123\",\n \"order\": {\n \"order_id\": \"11111111-2222-3333-4444-555555555555\",\n \"order_item_id\": \"11111111-2222-3333-4444-555555555555\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription\",\n \"attributes\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"pricing_option_id\": \"11111111-2222-3333-4444-555555555555\",\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"offering\": {\n \"type\": \"subscription_offering\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"external_plan_refs\": [\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\",\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n \"currency\": \"USD\",\n \"external_ref\": \"abc123\",\n \"address_id\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"canceled_at\": \"2017-01-10T11:41:19.244842Z\",\n \"paused_at\": \"2017-01-10T11:41:19.244842Z\",\n \"resumed_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_date\": \"2017-01-10T11:41:19.244842Z\",\n \"go_live_after\": \"2017-01-10T11:41:19.244842Z\",\n \"go_live\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"status\": \"active\",\n \"canceled\": true,\n \"paused\": true,\n \"closed\": true,\n \"pending\": false,\n \"suspended\": false,\n \"invoice_after\": \"2017-01-10T11:41:19.244842Z\",\n \"manual_payments\": false,\n \"first_invoice_prepaid\": false,\n \"state\": {\n \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n },\n \"meta\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"pending_price_change\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"price_update_history\": [\n {\n \"price_changes\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"valid_until\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"price_changes\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"valid_until\": \"2017-01-10T11:41:19.244842Z\"\n }\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aafd6996-a008-46a3-813c-029184cec03e", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"currency\": \"USD\",\n \"name\": \"Albert Einstein\",\n \"email\": \"albert@elasticpath.com\",\n \"manual_payments\": false,\n \"external_ref\": \"abc123\",\n \"address_id\": \"11111111-2222-3333-4444-555555555555\",\n \"offering_external_ref\": \"abc123\",\n \"offering_id\": \"11111111-2222-3333-4444-555555555555\",\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"pricing_option_id\": \"11111111-2222-3333-4444-555555555555\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n },\n \"pending\": false,\n \"first_invoice_paid\": false,\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"override_first_period_end_date\": \"2027-02-01T00:00:00Z\",\n \"offering\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"features\": [\n \"abc123\"\n ],\n \"plans\": [\n {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"meta\": {\n \"selected\": true\n }\n }\n ],\n \"pricing_options\": [\n {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"meta\": {\n \"selected\": true\n }\n }\n ],\n \"configured_features\": {\n \"key_0\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"key_1\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"key_2\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n },\n \"pricing_option_associations\": {\n \"key_0\": [\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"selected_plan\": \"abc123\",\n \"selected_pricing_option\": \"abc123\",\n \"order\": {\n \"order_id\": \"11111111-2222-3333-4444-555555555555\",\n \"order_item_id\": \"11111111-2222-3333-4444-555555555555\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "078c8d1a-5571-4a8f-a094-98a1e871db57", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"currency\": \"USD\",\n \"name\": \"Albert Einstein\",\n \"email\": \"albert@elasticpath.com\",\n \"manual_payments\": false,\n \"external_ref\": \"abc123\",\n \"address_id\": \"11111111-2222-3333-4444-555555555555\",\n \"offering_external_ref\": \"abc123\",\n \"offering_id\": \"11111111-2222-3333-4444-555555555555\",\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"pricing_option_id\": \"11111111-2222-3333-4444-555555555555\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n },\n \"pending\": false,\n \"first_invoice_paid\": false,\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"override_first_period_end_date\": \"2027-02-01T00:00:00Z\",\n \"offering\": {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"features\": [\n \"abc123\"\n ],\n \"plans\": [\n {\n \"name\": \"Magazine\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n },\n \"meta\": {\n \"selected\": true\n }\n }\n ],\n \"pricing_options\": [\n {\n \"name\": \"Monthly\",\n \"billing_interval_type\": \"month\",\n \"billing_frequency\": 1,\n \"plan_length\": 12,\n \"end_behavior\": \"close\",\n \"can_pause\": false,\n \"can_resume\": false,\n \"can_cancel\": false,\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"meta\": {\n \"selected\": true\n }\n }\n ],\n \"configured_features\": {\n \"key_0\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"key_1\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"key_2\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n }\n },\n \"pricing_option_associations\": {\n \"key_0\": [\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n ]\n },\n \"selected_plan\": \"abc123\",\n \"selected_pricing_option\": \"abc123\",\n \"order\": {\n \"order_id\": \"11111111-2222-3333-4444-555555555555\",\n \"order_item_id\": \"11111111-2222-3333-4444-555555555555\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3c51c99-8315-4c3a-9e69-5821f6f2838a", "name": "List subscriptions", "request": { "name": "List subscriptions", "description": { "content": "Retrieves a list of all subscriptions.\n\n### Filtering\n\nThis endpoint supports filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description |\n| --- | --- | --- | \n| `eq` | `account_id`, `name`, `email`, `external_ref` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |\n| `in` | `account_id`, `name`, `email`, `external_ref` | In. Checks if the value is in the specified list. If it is, the condition is true. |\n\n### Including Resources\n\nYou can use the `include` parameter to include the following resources with this endpoint.\n\n| Resource | Required | Description |\n| --- | --- | --- |\n| `pricing_options, plans` | Optional | Retrieves all pricing options and plans associated with a subscription. |\n| `plans` | Optional | Retrieves all plans associated with a subscription. |\n| `pricing_options` | Optional | Retrieves all pricing options associated with a subscription. |\n\nSee [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "549ffa9c-4451-42aa-873c-c94ca5b406d6", "name": "Success. A list of subscriptions is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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 \"type\": \"subscription\",\n \"attributes\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"pricing_option_id\": \"11111111-2222-3333-4444-555555555555\",\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"offering\": {\n \"type\": \"subscription_offering\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"external_plan_refs\": [\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\",\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n \"currency\": \"USD\",\n \"external_ref\": \"abc123\",\n \"address_id\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"canceled_at\": \"2017-01-10T11:41:19.244842Z\",\n \"paused_at\": \"2017-01-10T11:41:19.244842Z\",\n \"resumed_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_date\": \"2017-01-10T11:41:19.244842Z\",\n \"go_live_after\": \"2017-01-10T11:41:19.244842Z\",\n \"go_live\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"status\": \"active\",\n \"canceled\": true,\n \"paused\": true,\n \"closed\": true,\n \"pending\": false,\n \"suspended\": false,\n \"invoice_after\": \"2017-01-10T11:41:19.244842Z\",\n \"manual_payments\": false,\n \"first_invoice_prepaid\": false,\n \"state\": {\n \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n },\n \"meta\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"pending_price_change\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"price_update_history\": [\n {\n \"price_changes\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"valid_until\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"price_changes\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"valid_until\": \"2017-01-10T11:41:19.244842Z\"\n }\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription\",\n \"attributes\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"pricing_option_id\": \"11111111-2222-3333-4444-555555555555\",\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"offering\": {\n \"type\": \"subscription_offering\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"external_plan_refs\": [\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\",\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n \"currency\": \"USD\",\n \"external_ref\": \"abc123\",\n \"address_id\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"canceled_at\": \"2017-01-10T11:41:19.244842Z\",\n \"paused_at\": \"2017-01-10T11:41:19.244842Z\",\n \"resumed_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_date\": \"2017-01-10T11:41:19.244842Z\",\n \"go_live_after\": \"2017-01-10T11:41:19.244842Z\",\n \"go_live\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"status\": \"active\",\n \"canceled\": true,\n \"paused\": true,\n \"closed\": true,\n \"pending\": false,\n \"suspended\": false,\n \"invoice_after\": \"2017-01-10T11:41:19.244842Z\",\n \"manual_payments\": false,\n \"first_invoice_prepaid\": false,\n \"state\": {\n \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n },\n \"meta\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"pending_price_change\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"price_update_history\": [\n {\n \"price_changes\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"valid_until\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"price_changes\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"valid_until\": \"2017-01-10T11:41:19.244842Z\"\n }\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"included\": {\n \"plans\": [\n {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n },\n \"key_2\": {\n \"type\": \"access\"\n },\n \"key_3\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_3\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"pricing_options\": [\n {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_2\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_2\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ]\n },\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e10aa5a6-fcee-4229-9ec4-47fa1af2d1eb", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "547025ea-bf36-47bf-9588-91b7d1b5e460", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7aee4700-da06-4973-b22e-d3113f150fcb", "name": "Get subscription", "request": { "name": "Get subscription", "description": {}, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" } ], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c640738f-d83c-48e8-bb8c-ccec28174e91", "name": "Success. The details of a subscription are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"type\": \"subscription\",\n \"attributes\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"pricing_option_id\": \"11111111-2222-3333-4444-555555555555\",\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"offering\": {\n \"type\": \"subscription_offering\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"external_plan_refs\": [\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\",\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n \"currency\": \"USD\",\n \"external_ref\": \"abc123\",\n \"address_id\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"canceled_at\": \"2017-01-10T11:41:19.244842Z\",\n \"paused_at\": \"2017-01-10T11:41:19.244842Z\",\n \"resumed_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_date\": \"2017-01-10T11:41:19.244842Z\",\n \"go_live_after\": \"2017-01-10T11:41:19.244842Z\",\n \"go_live\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"status\": \"active\",\n \"canceled\": true,\n \"paused\": true,\n \"closed\": true,\n \"pending\": false,\n \"suspended\": false,\n \"invoice_after\": \"2017-01-10T11:41:19.244842Z\",\n \"manual_payments\": false,\n \"first_invoice_prepaid\": false,\n \"state\": {\n \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n },\n \"meta\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"pending_price_change\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"price_update_history\": [\n {\n \"price_changes\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"valid_until\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"price_changes\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"valid_until\": \"2017-01-10T11:41:19.244842Z\"\n }\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n \"included\": {\n \"plans\": [\n {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_2\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"pricing_options\": [\n {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_2\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a88fab9-c025-482c-8af7-e8ea637d082e", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1655d5cd-a492-42c6-a76f-6cbc0756f206", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef9ac294-0efb-4608-870f-f3c01e4a7221", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "include", "value": "plans,pricing_options" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dccb4bf0-f9d7-4280-9879-2c60c2e9e71c", "name": "Update a subscription", "request": { "name": "Update a subscription", "description": { "content": "Updates a subscription. For example, a subscriber can switch from one pricing option to another in a subscription.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription\",\n \"attributes\": {\n \"pricing_option_id\": \"00000000-0000-0000-0000-000000000001\",\n \"plan_id\": \"00000000-0000-0000-0000-000000000001\",\n \"address_id\": \"00000000-0000-0000-0000-000000000001\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n },\n \"go_live_after\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a66f3fd9-99ce-4697-84b7-583f29fd27cd", "name": "Success. The subscription is updated.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription\",\n \"attributes\": {\n \"pricing_option_id\": \"00000000-0000-0000-0000-000000000001\",\n \"plan_id\": \"00000000-0000-0000-0000-000000000001\",\n \"address_id\": \"00000000-0000-0000-0000-000000000001\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n },\n \"go_live_after\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription\",\n \"attributes\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"pricing_option_id\": \"11111111-2222-3333-4444-555555555555\",\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"offering\": {\n \"type\": \"subscription_offering\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"external_plan_refs\": [\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\",\n \"97dddc65-eabd-45d8-b45b-2ece5cfc8c50\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n \"currency\": \"USD\",\n \"external_ref\": \"abc123\",\n \"address_id\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"canceled_at\": \"2017-01-10T11:41:19.244842Z\",\n \"paused_at\": \"2017-01-10T11:41:19.244842Z\",\n \"resumed_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_date\": \"2017-01-10T11:41:19.244842Z\",\n \"go_live_after\": \"2017-01-10T11:41:19.244842Z\",\n \"go_live\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"status\": \"active\",\n \"canceled\": true,\n \"paused\": true,\n \"closed\": true,\n \"pending\": false,\n \"suspended\": false,\n \"invoice_after\": \"2017-01-10T11:41:19.244842Z\",\n \"manual_payments\": false,\n \"first_invoice_prepaid\": false,\n \"state\": {\n \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n },\n \"meta\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"pending_price_change\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"price_update_history\": [\n {\n \"price_changes\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"valid_until\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"price_changes\": {\n \"plan_prices\": {\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"pricing_option_prices\": {\n \"83f6b8e3-031c-4f2a-a1d7-b1c83cb5ac3c\": {\n \"base_price_percentage\": 90\n },\n \"197a11f4-d341-4594-9574-7fbfbe6a671d\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"valid_until\": \"2017-01-10T11:41:19.244842Z\"\n }\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76e87508-ae9a-418b-8e3f-468f0024cd48", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription\",\n \"attributes\": {\n \"pricing_option_id\": \"00000000-0000-0000-0000-000000000001\",\n \"plan_id\": \"00000000-0000-0000-0000-000000000001\",\n \"address_id\": \"00000000-0000-0000-0000-000000000001\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n },\n \"go_live_after\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cbfd508-9370-44fc-afc2-a9b90758e98e", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription\",\n \"attributes\": {\n \"pricing_option_id\": \"00000000-0000-0000-0000-000000000001\",\n \"plan_id\": \"00000000-0000-0000-0000-000000000001\",\n \"address_id\": \"00000000-0000-0000-0000-000000000001\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n },\n \"go_live_after\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "050349fb-0c66-4b50-85e4-9233b3db3545", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription\",\n \"attributes\": {\n \"pricing_option_id\": \"00000000-0000-0000-0000-000000000001\",\n \"plan_id\": \"00000000-0000-0000-0000-000000000001\",\n \"address_id\": \"00000000-0000-0000-0000-000000000001\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n },\n \"go_live_after\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12e50faf-ba59-4816-9e87-ad8583fb2b79", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription\",\n \"attributes\": {\n \"pricing_option_id\": \"00000000-0000-0000-0000-000000000001\",\n \"plan_id\": \"00000000-0000-0000-0000-000000000001\",\n \"address_id\": \"00000000-0000-0000-0000-000000000001\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n },\n \"go_live_after\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2a6bb4b-0d6c-4caa-abc5-b386df66a404", "name": "Delete a subscription", "request": { "name": "Delete a subscription", "description": { "content": "Deletes a subscription\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "44c29ab6-7664-4454-a7af-60b95568a820", "name": "Success. The subscription is removed.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "fa8a7dcd-1f33-4afc-9fec-0891dfc575b6", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93ef4e16-3a34-4cba-9be6-4f782251a424", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "534ef26b-8316-48f1-972e-162b2f275e55", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5757ce85-c157-4a50-8a13-a9ddbd60d77b", "name": "Get a feature in a subscription", "request": { "name": "Get a feature in a subscription", "description": {}, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e9b7b390-4ddc-419b-bd54-873bde995a09", "name": "Success. The details of the feature are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9195084-dc5b-42e4-8b8c-5aec4a81aeaf", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59bcafcd-99aa-41cd-bb60-fb8727110f97", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0efbcde5-69ba-446e-9f9e-08d4962dd9c3", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "features", ":feature_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the feature.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "feature_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78ce41be-074a-4598-a4a4-715775f1fd57", "name": "Get a plan in a subscription", "request": { "name": "Get a plan in a subscription", "description": {}, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "96177106-5830-42b4-baa7-6cdb946f9e87", "name": "Success. The details of the plan are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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 \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_2\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b84ac69-560a-41d6-a148-d20d67d00cbe", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b8212de-5190-4f99-b111-006a08016392", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d414fdb2-0cc5-47f1-8ee3-25c19fce5fc9", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans", ":plan_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the plan.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "plan_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8837d2d-1831-403f-bb3f-25dcb9aeed99", "name": "Get a pricing option in a subscription", "request": { "name": "Get a pricing option in a subscription", "description": {}, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "77b5d4f9-b000-4915-83bf-6f1ee8598d43", "name": "Success. The details of the pricing option are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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 \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_2\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3264b5b5-09f5-4aef-a36c-b4eaa928bfe0", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "264769f1-8dbd-4754-a094-d30c630a5300", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "517232a1-9391-4512-bc6d-72698cd1ad58", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "pricing-options", ":pricing_option_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the pricing option.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "pricing_option_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7d9bc1b-2847-4cbd-b017-352832f0ba4c", "name": "List an subscriptions features", "request": { "name": "List an subscriptions features", "description": {}, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "303c73c9-8e93-49d5-acee-7d7d23ad3fec", "name": "Success. A list of subscription features is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_feature\",\n \"attributes\": {\n \"name\": \"Digital library access\",\n \"configuration\": {\n \"type\": \"access\",\n \"tag\": \"digital_library_access\"\n },\n \"external_ref\": \"abc123\",\n \"description\": \"Access to over 100 ebooks via the digital library.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5103fa6f-4e4b-4171-b291-9cebd803420c", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5db9f754-df8c-496f-bb86-8eb59a213ef4", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "features" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4846c7b-f01a-4021-9a10-3a28fea1b4db", "name": "List subscription plans", "request": { "name": "List subscription plans", "description": { "content": "Retrieves a list of plans associated with the specified subscription. Using this endpoint you can see the plan that is currently active in a subscription. If `active_plan` is `true`, a plan is active in a subscription. If `active_plan` is null, the pricing option is not active.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ad48d683-c185-475f-8eac-330076a09d58", "name": "Success. A list of subscription plans is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_plan\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"feature_configurations\": {\n \"key_0\": {\n \"type\": \"access\"\n },\n \"key_1\": {\n \"type\": \"access\"\n },\n \"key_2\": {\n \"type\": \"access\"\n }\n },\n \"name\": \"Magazine\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A lovely magazine that is published every month.\",\n \"sku\": \"MAGAZINE1\",\n \"main_image\": \"https://magazine.com/cover.jpg\",\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"price_units\": {\n \"unit\": \"day\",\n \"amount\": 7\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_plan\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f5fe8a0-2a53-4312-872b-d01b8e1628c3", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3ae7fbd-ce0e-4b64-ac1f-f428cbea3f27", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9196078-bc5b-4dd2-b88d-aa2e608c2db8", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f367eff-0c62-47f0-8aed-861c58a79ec6", "name": "Manage subscription plans", "request": { "name": "Manage subscription plans", "description": { "content": "Manage subscription plans by replacing, changing or detaching plans on the subscription", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"type\": \"attach\",\n \"plans\": [\n \"bafa601f-359c-48da-834e-377b6c0d9466\"\n ]\n },\n {\n \"type\": \"detach\",\n \"plans\": [\n \"a8aad94d-60fc-44f7-8dfa-299249566ec4\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "26e1132c-8955-4ec3-be4d-c48e8a35c41d", "name": "Success. The subscription's plans have been updated.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "header": [ { "key": "Content-Type", "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 \"data\": [\n {\n \"type\": \"attach\",\n \"plans\": [\n \"bafa601f-359c-48da-834e-377b6c0d9466\"\n ]\n },\n {\n \"type\": \"detach\",\n \"plans\": [\n \"a8aad94d-60fc-44f7-8dfa-299249566ec4\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0fa94c45-2b0a-4eda-b999-592c02f7498c", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"data\": [\n {\n \"type\": \"attach\",\n \"plans\": [\n \"bafa601f-359c-48da-834e-377b6c0d9466\"\n ]\n },\n {\n \"type\": \"detach\",\n \"plans\": [\n \"a8aad94d-60fc-44f7-8dfa-299249566ec4\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae306860-4621-4eca-9dc4-53bc43f91751", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"data\": [\n {\n \"type\": \"attach\",\n \"plans\": [\n \"bafa601f-359c-48da-834e-377b6c0d9466\"\n ]\n },\n {\n \"type\": \"detach\",\n \"plans\": [\n \"a8aad94d-60fc-44f7-8dfa-299249566ec4\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09dcbd03-56e2-4c21-9279-e8d73c952a14", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"data\": [\n {\n \"type\": \"attach\",\n \"plans\": [\n \"bafa601f-359c-48da-834e-377b6c0d9466\"\n ]\n },\n {\n \"type\": \"detach\",\n \"plans\": [\n \"a8aad94d-60fc-44f7-8dfa-299249566ec4\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfe588bc-d8de-45d2-9d86-812f1e72d3cb", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "plans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"data\": [\n {\n \"type\": \"attach\",\n \"plans\": [\n \"bafa601f-359c-48da-834e-377b6c0d9466\"\n ]\n },\n {\n \"type\": \"detach\",\n \"plans\": [\n \"a8aad94d-60fc-44f7-8dfa-299249566ec4\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f7f6dca-f898-491a-bb25-aa10e6210569", "name": "List subscription pricing options", "request": { "name": "List subscription pricing options", "description": { "content": "Retrieves a list of pricing options associated with the specified subscription. Using this endpoint you can see the pricing options that are currently active in a subscription. If `active_pricing_option` is `true`, a pricing option is active in a subscription. If `active_pricing_option` is null, the pricing option is not active.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "936fb93c-e7b8-4910-8382-dabe929d7d33", "name": "Success. A list of subscription pricing options is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_offering_pricing_option\",\n \"attributes\": {\n \"billing_frequency\": 1,\n \"billing_interval_type\": \"month\",\n \"can_cancel\": false,\n \"can_pause\": false,\n \"can_resume\": false,\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"end_behavior\": \"close\",\n \"name\": \"Monthly\",\n \"plan_length\": 12,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"description\": \"A monthly subscription.\",\n \"trial_period\": 7,\n \"lead_time\": {\n \"type\": \"day\",\n \"time\": 14\n },\n \"notification_schedule\": [\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n },\n {\n \"name\": \"Daily billing run.\",\n \"unit\": \"day\",\n \"amount\": 100\n }\n ],\n \"base_price_percentage\": 90,\n \"fixed_price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"prices\": {\n \"key_0\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n },\n \"key_1\": {\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n }\n }\n },\n \"price\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"active_pricing_option\": true\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_3\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_4\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76fc0dab-1737-4a63-9a06-f7fb212b257e", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8481e349-1542-4c1b-bfa0-24a64aeed0a0", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8f286a8-be78-4e0a-827c-84e166be2371", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "pricing-options" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e388a3dd-2da1-4fd8-a39a-3a3ef34ff0b1", "name": "Create a subscription state", "request": { "name": "Create a subscription state", "description": { "content": "The subscription lifecycle is the states that a subscription can go through when a customer subscribes to a service or a plan. \n\nA subscription can have the following states:\n\n- `pending` \n- `canceled`\n- `paused`\n- `resumed`\nFor more information, see [Managing the Subscription Lifecycle](/docs/api/subscriptions/subscriptions#managing-the-subscription-lifecycle).\n\nImmediate cancellation (`cancel` with `cancel_immediately: true`) ends the subscription and updates entitlements in this request; it does **not** issue refunds or modify paid invoices. Use payments refund flows separately if needed.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "291dc241-e211-4075-ae1a-3c765574d1ae", "name": "Success. The subscription's state has changed.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "header": [ { "key": "Content-Type", "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 \"data\": {\n \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c8f330c-e4ff-4ece-82e4-30b41b173103", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0ea83c6-b9f4-4400-90f9-067b6680de5b", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dca5755b-dfab-4559-9c60-ebce2709530b", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d8bd00d-6072-457e-bfc6-f5af7caf007d", "name": "Unprocessable Content.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\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 \"errors\": [\n {\n \"title\": \"Unprocessable Content\",\n \"status\": \"422\",\n \"detail\": \"Unprocessable Content: cannot process the refund\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e5aefa5-5c52-4425-837d-8de7d6c66070", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce64d4df-8a26-490e-9b2a-798536c0db8c", "name": "List subscription states", "request": { "name": "List subscription states", "description": {}, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ab60ed02-8be4-485d-9705-aa49589c1631", "name": "Success. A list of subscription states is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n },\n \"meta\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n },\n \"meta\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e01dbf6b-4a1e-4710-a47b-1304abfb9083", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6310b846-2ebd-4bc5-867e-4a02b994f56c", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aceb9977-5626-40db-beeb-3c82008f7ea4", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "762c35ce-3871-4b89-a09c-bd5fdc1069d8", "name": "Get subscription state", "request": { "name": "Get subscription state", "description": {}, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states", ":state_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "state_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription state.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "853f708b-b41f-48c2-a56d-355e92d896e7", "name": "Success. A subscription state is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states", ":state_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription state.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "state_uuid" } ] }, "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 \"type\": \"subscription_state\",\n \"attributes\": {\n \"action\": \"cancel\",\n \"cancel_immediately\": false\n },\n \"meta\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6bacea2-6b08-4918-8eb1-ec1a11f9a362", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states", ":state_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription state.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "state_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8de3ae73-0a0c-455d-a4f2-5a8f1fd1cbc7", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states", ":state_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription state.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "state_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b45b2181-570b-45b3-bdf9-cafc7e9d7e95", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "states", ":state_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription state.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "state_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "debe8dba-3745-4c14-b93c-ceb18f230d06", "name": "List subscription invoices", "request": { "name": "List subscription invoices", "description": { "content": "Lists all invoices for a given subscription.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "134514f3-f487-46bb-a4e0-35c9a766a5e2", "name": "Success. A list of invoices is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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 \"type\": \"subscription_invoice\",\n \"attributes\": {\n \"billing_period\": {\n \"start\": \"2017-07-21T17:32:28Z\",\n \"end\": \"2017-07-21T17:32:28Z\"\n },\n \"pro_forma\": false,\n \"invoice_items\": [\n {\n \"description\": \"Magazine issue\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"from_time_period\": \"2017-01-10T11:41:19.244842Z\",\n \"until_time_period\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"description\": \"Magazine issue\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"from_time_period\": \"2017-01-10T11:41:19.244842Z\",\n \"until_time_period\": \"2017-01-10T11:41:19.244842Z\"\n }\n ],\n \"outstanding\": true,\n \"tax_required\": true,\n \"payment_retries_limit_reached\": false,\n \"manual_payment_pending\": true,\n \"tax_items\": [\n {\n \"type\": \"tax_item\",\n \"rate\": 0.2,\n \"name\": \"GST\",\n \"code\": \"20.0 % S\",\n \"jurisdiction\": \"USA\"\n },\n {\n \"type\": \"tax_item\",\n \"rate\": 0.2,\n \"name\": \"GST\",\n \"code\": \"20.0 % S\",\n \"jurisdiction\": \"USA\"\n }\n ],\n \"number\": 1,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"valid_from\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"taxes_added_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"proration_events\": [\n {\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"billing_cost_before_proration\": 100,\n \"refunded_amount_for_unused_pricing_option\": 100,\n \"new_pricing_option_cost\": 100,\n \"prorated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"billing_cost_before_proration\": 100,\n \"refunded_amount_for_unused_pricing_option\": 100,\n \"new_pricing_option_cost\": 100,\n \"prorated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n ],\n \"pro_rata_remaining_value\": 500,\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"subscription_id\": \"11111111-2222-3333-4444-555555555555\",\n \"subscriber_id\": \"11111111-2222-3333-4444-555555555555\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"notifications\": [\n {\n \"name\": \"7 days before renewal\",\n \"due\": \"2024-01-24T00:00:00Z\",\n \"sent_at\": \"2024-01-24T00:00:00Z\"\n },\n {\n \"name\": \"7 days before renewal\",\n \"due\": \"2024-01-24T00:00:00Z\",\n \"sent_at\": \"2024-01-24T00:00:00Z\"\n }\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_invoice\",\n \"attributes\": {\n \"billing_period\": {\n \"start\": \"2017-07-21T17:32:28Z\",\n \"end\": \"2017-07-21T17:32:28Z\"\n },\n \"pro_forma\": false,\n \"invoice_items\": [\n {\n \"description\": \"Magazine issue\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"from_time_period\": \"2017-01-10T11:41:19.244842Z\",\n \"until_time_period\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"description\": \"Magazine issue\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"from_time_period\": \"2017-01-10T11:41:19.244842Z\",\n \"until_time_period\": \"2017-01-10T11:41:19.244842Z\"\n }\n ],\n \"outstanding\": true,\n \"tax_required\": true,\n \"payment_retries_limit_reached\": false,\n \"manual_payment_pending\": true,\n \"tax_items\": [\n {\n \"type\": \"tax_item\",\n \"rate\": 0.2,\n \"name\": \"GST\",\n \"code\": \"20.0 % S\",\n \"jurisdiction\": \"USA\"\n },\n {\n \"type\": \"tax_item\",\n \"rate\": 0.2,\n \"name\": \"GST\",\n \"code\": \"20.0 % S\",\n \"jurisdiction\": \"USA\"\n }\n ],\n \"number\": 1,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"valid_from\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"taxes_added_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"proration_events\": [\n {\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"billing_cost_before_proration\": 100,\n \"refunded_amount_for_unused_pricing_option\": 100,\n \"new_pricing_option_cost\": 100,\n \"prorated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"billing_cost_before_proration\": 100,\n \"refunded_amount_for_unused_pricing_option\": 100,\n \"new_pricing_option_cost\": 100,\n \"prorated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n ],\n \"pro_rata_remaining_value\": 500,\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"subscription_id\": \"11111111-2222-3333-4444-555555555555\",\n \"subscriber_id\": \"11111111-2222-3333-4444-555555555555\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"notifications\": [\n {\n \"name\": \"7 days before renewal\",\n \"due\": \"2024-01-24T00:00:00Z\",\n \"sent_at\": \"2024-01-24T00:00:00Z\"\n },\n {\n \"name\": \"7 days before renewal\",\n \"due\": \"2024-01-24T00:00:00Z\",\n \"sent_at\": \"2024-01-24T00:00:00Z\"\n }\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43c85d39-201e-4ac2-8d24-d7dcbb669eea", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5171126b-5924-452f-bfc0-34c440260082", "name": "List subscription invoice payments", "request": { "name": "List subscription invoice payments", "description": { "content": "Lists all invoice payments for a given invoice.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "invoices", ":invoice_uuid", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0000cb6a-75b6-42d9-a485-b7be6f1749d6", "name": "Success. Payments for the invoice are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "invoices", ":invoice_uuid", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" } ] }, "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\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment\",\n \"attributes\": {\n \"success\": true,\n \"amount\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"gateway\": \"elastic_path_payments_stripe\",\n \"pending\": true,\n \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"failure_detail\": {\n \"reason\": \"Card Failure\"\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"invoice_id\": \"11111111-2222-3333-4444-555555555555\",\n \"subscription_id\": \"11111111-2222-3333-4444-555555555555\",\n \"job_id\": \"11111111-2222-3333-4444-555555555555\",\n \"manual_payment\": false\n }\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment\",\n \"attributes\": {\n \"success\": true,\n \"amount\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"gateway\": \"elastic_path_payments_stripe\",\n \"pending\": true,\n \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"failure_detail\": {\n \"reason\": \"Card Failure\"\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"invoice_id\": \"11111111-2222-3333-4444-555555555555\",\n \"subscription_id\": \"11111111-2222-3333-4444-555555555555\",\n \"job_id\": \"11111111-2222-3333-4444-555555555555\",\n \"manual_payment\": false\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61edc3e7-12e9-4dbf-ab53-7c23e89492cd", "name": "Get subscription invoice payment", "request": { "name": "Get subscription invoice payment", "description": { "content": "Gets a specific payment for a given invoice.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "invoices", ":invoice_uuid", "payments", ":payment_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "292b7fb0-e36d-433f-ba10-537fe360e20a", "name": "Success. Specific payment for the invoice is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "invoices", ":invoice_uuid", "payments", ":payment_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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 \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment\",\n \"attributes\": {\n \"success\": true,\n \"amount\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"gateway\": \"elastic_path_payments_stripe\",\n \"pending\": true,\n \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"failure_detail\": {\n \"reason\": \"Card Failure\"\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"invoice_id\": \"11111111-2222-3333-4444-555555555555\",\n \"subscription_id\": \"11111111-2222-3333-4444-555555555555\",\n \"job_id\": \"11111111-2222-3333-4444-555555555555\",\n \"manual_payment\": false\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93445557-f980-496d-b2cc-ac4c18074c04", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "invoices", ":invoice_uuid", "payments", ":payment_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee03e899-7805-40a9-8724-cf3ef0a9c8cc", "name": "Get subscription invoice", "request": { "name": "Get subscription invoice", "description": { "content": "Gets a specific invoice for a given subscription.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "invoices", ":invoice_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0889c0a8-04e2-41d6-b044-383c2ffa1f1c", "name": "Success. An invoice is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "invoices", ":invoice_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" } ] }, "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 \"type\": \"subscription_invoice\",\n \"attributes\": {\n \"billing_period\": {\n \"start\": \"2017-07-21T17:32:28Z\",\n \"end\": \"2017-07-21T17:32:28Z\"\n },\n \"pro_forma\": false,\n \"invoice_items\": [\n {\n \"description\": \"Magazine issue\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"from_time_period\": \"2017-01-10T11:41:19.244842Z\",\n \"until_time_period\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"description\": \"Magazine issue\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"from_time_period\": \"2017-01-10T11:41:19.244842Z\",\n \"until_time_period\": \"2017-01-10T11:41:19.244842Z\"\n }\n ],\n \"outstanding\": true,\n \"tax_required\": true,\n \"payment_retries_limit_reached\": false,\n \"manual_payment_pending\": true,\n \"tax_items\": [\n {\n \"type\": \"tax_item\",\n \"rate\": 0.2,\n \"name\": \"GST\",\n \"code\": \"20.0 % S\",\n \"jurisdiction\": \"USA\"\n },\n {\n \"type\": \"tax_item\",\n \"rate\": 0.2,\n \"name\": \"GST\",\n \"code\": \"20.0 % S\",\n \"jurisdiction\": \"USA\"\n }\n ],\n \"number\": 1,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"valid_from\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"taxes_added_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"proration_events\": [\n {\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"billing_cost_before_proration\": 100,\n \"refunded_amount_for_unused_pricing_option\": 100,\n \"new_pricing_option_cost\": 100,\n \"prorated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"billing_cost_before_proration\": 100,\n \"refunded_amount_for_unused_pricing_option\": 100,\n \"new_pricing_option_cost\": 100,\n \"prorated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n ],\n \"pro_rata_remaining_value\": 500,\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"subscription_id\": \"11111111-2222-3333-4444-555555555555\",\n \"subscriber_id\": \"11111111-2222-3333-4444-555555555555\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"notifications\": [\n {\n \"name\": \"7 days before renewal\",\n \"due\": \"2024-01-24T00:00:00Z\",\n \"sent_at\": \"2024-01-24T00:00:00Z\"\n },\n {\n \"name\": \"7 days before renewal\",\n \"due\": \"2024-01-24T00:00:00Z\",\n \"sent_at\": \"2024-01-24T00:00:00Z\"\n }\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47d9fe16-0a66-4fb9-ad56-902151a7be6f", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "invoices", ":invoice_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aceb178d-77df-41ab-a9bc-50323cfc09d5", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscriptions", ":subscription_uuid", "invoices", ":invoice_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscription.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscription_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Jobs", "description": "Jobs are an asynchronous process that can be triggered manually or scheduled. \n\nThere are three types of job:\n\n- a billing run. Subscriptions generates an [**invoice**](/docs/api/subscriptions/invoices) when a billing run occurs. Billing runs generate invoices for the remaining billing cycles for each subscription. The invoice dates come from your pricing options. Billing runs are independent of payment runs.\n- a tax run. Invoices where `tax_required` is `true` will not have payment taken until a tax run has added the required tax to the invoice.\n- a payment run. The payment run identifies invoices that are outstanding and attempts to take payment for them. If the payment succeeds the the invoice is no longer outstanding. If the payment fails for any reason, then the invoice remains outstanding and is picked up by the next payment run to retry the payment.\n\nBy scheduling billing and payment runs, you automate the process, reducing manual intervention and ensuring the jobs are run in a timely manner. See [**Schedules**](/docs/api/subscriptions/schedules).\n\n### Characteristics of Billing, Tax & Payments Jobs\n\nBilling and payment jobs have the following characteristics.\n\n- Jobs are asynchronous.\n- Jobs have a different status, depending on where a job is in its lifecycle.\n- Jobs report any errors to help you understand the reason for any failed jobs.\n- Only one billing run and payment run is allowed per store at a time. Although billing and payments are constantly generated, the jobs are queued. Subscriptions looks for any jobs that have a status of PENDING and starts the job with the earliest created date. This process is repeated until all jobs are processed.\n\n### Billing, Tax & Payments Jobs Lifecycle\n\nA job can have the following status types:\n\n- PENDING - Subscriptions has received the request but is currently busy processing other requests.\n- STARTED - Subscriptions has started processing the job.\n- SUCCESS - The job has successfully completed.\n- FAILED - The job has failed.\n\n### Billing, Tax & Payment Reports\n\nYou can track your Subscriptions billing, payment and tax operations using reports. There are three types of report:\n\n- `BillingRunReport` - This report provides invoice summaries such as invoices ready for payment, invoices that require tax, and invoice failures.\n- `TaxRunReport` - This report provides invoice summaries such as invoices to which tax was successfully or unsuccessfully added.\n- `PaymentRunReport` - This report provides invoice summaries such as invoices for which payment was attempted, failed payment attempts and totals collected by a payment run. \n- `NotificationRunReport` - This report provides notification summaries such as notifications sent and failed to send.\n- `SubscriptionUpdateReport` - This report provides subscription update summaries such as subscriptions that were updated successfully and failed updates.\n\nSee [Get a job](/docs/api/subscriptions/get-job) and [List jobs](/docs/api/subscriptions/list-jobs).\n", "item": [ { "id": "0ca30a16-e58c-4be2-aa50-981ac1040c0b", "name": "Create a job", "request": { "name": "Create a job", "description": {}, "url": { "path": [ "v2", "subscriptions", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_job\",\n \"attributes\": {\n \"job_type\": \"billing-run\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5c88d0a3-6e07-440e-bee7-62c427a159a6", "name": "Success. The job was created.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_job\",\n \"attributes\": {\n \"job_type\": \"billing-run\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_job\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"job_type\": \"billing-run\",\n \"status\": \"pending\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"finished_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"report\": {\n \"invoices_ready_for_payment\": 100,\n \"invoices_tax_required\": 100,\n \"invoice_failures\": 0,\n \"total_ready_for_payment\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"total_tax_required\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d65be3f-ed0b-4686-9310-8ceed75f9c3e", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_job\",\n \"attributes\": {\n \"job_type\": \"billing-run\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce9969d9-2494-4a41-a145-1d825ef32e3c", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_job\",\n \"attributes\": {\n \"job_type\": \"billing-run\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2999f5cc-b33a-4208-8284-865446988d67", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_job\",\n \"attributes\": {\n \"job_type\": \"billing-run\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3745d97b-e460-45fd-a82a-7e76ef361467", "name": "List jobs", "request": { "name": "List jobs", "description": { "content": "Retrieves a list of all jobs.\n\n### Filtering\n\nThis endpoint supports filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description |\n| --- | --- | --- | \n| `eq` | `external_ref` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |\n| `in` | `external_ref` | In. Checks if the value is in the specified list. If it is, the condition is true. |\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cd406896-dfc7-48c9-9a66-3c171520d5ce", "name": "Success. A list of jobs is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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 \"type\": \"subscription_job\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"job_type\": \"billing-run\",\n \"status\": \"pending\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"finished_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"report\": {\n \"invoices_ready_for_payment\": 100,\n \"invoices_tax_required\": 100,\n \"invoice_failures\": 0,\n \"total_ready_for_payment\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"total_tax_required\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_job\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"job_type\": \"billing-run\",\n \"status\": \"pending\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"finished_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"report\": {\n \"invoices_ready_for_payment\": 100,\n \"invoices_tax_required\": 100,\n \"invoice_failures\": 0,\n \"total_ready_for_payment\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"total_tax_required\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\",\n \"key_2\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cac0525-8e37-4e2a-af84-67e3e4b78d83", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e5d109f-b0dc-48df-ab17-6c04b6ec9436", "name": "Get job", "request": { "name": "Get job", "description": {}, "url": { "path": [ "v2", "subscriptions", "jobs", ":job_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "job_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "15b6246d-a7da-449a-8f91-703cd31dded7", "name": "Success. The job is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "jobs", ":job_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the job.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "job_uuid" } ] }, "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 \"type\": \"subscription_job\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"job_type\": \"billing-run\",\n \"status\": \"pending\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"finished_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"report\": {\n \"invoices_ready_for_payment\": 100,\n \"invoices_tax_required\": 100,\n \"invoice_failures\": 0,\n \"total_ready_for_payment\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n },\n \"total_tax_required\": {\n \"USD\": {\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"GBP\": {\n \"amount\": 90,\n \"includes_tax\": true\n }\n }\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37f2a875-8807-415c-9cce-00eeb6f10b79", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "jobs", ":job_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the job.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "job_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5031569-85bb-4ed7-8a25-efdeddca1a39", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "jobs", ":job_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the job.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "job_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa2a30d4-0f3b-47c7-a328-b35a93705021", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "jobs", ":job_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the job.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "job_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81199beb-187f-4ce0-a374-f4ad8ce4bd86", "name": "Delete job", "request": { "name": "Delete job", "description": {}, "url": { "path": [ "v2", "subscriptions", "jobs", ":job_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "job_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the job.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "de42c915-20e2-4f43-bdb9-df92e5110f8b", "name": "Success. The job was deleted.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "jobs", ":job_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the job.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "job_uuid" } ] }, "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": "65add0ed-a77e-4ac8-b5bd-15148f1bf450", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "jobs", ":job_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the job.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "job_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Imports", "description": "You can import subscription features, subscribers, offerings and subscriptions using Subscriptions Import. This is useful if you want to import subscriptions from an external system into Elastic Path Subscriptions. \n\nThe API uses a [**JSONL**](https://jsonlines.org/) file. Here is an [**example of a JSONL file**](/assets/subscriptions_import.jsonl).\n\nWhen you send an import request, an import job is created. Jobs are processed one at a time. You can continue to send import requests, but those jobs are queued. In other words, Subscriptions looks for any jobs that have a status of PENDING and starts the job with the earliest created date. This process is repeated until all jobs are processed. Use [List import jobs](/docs/api/subscriptions/list-import-jobs) to see a list of all import jobs.\n\nA file can include up to 50,000 objects. If you have more than 50,000 objects, then you must create a separate file, and import each file, one at a time.\n\n### Characteristics of Subscriptions Import\n\nThe Subscriptions Import API has the following characteristics:\n\n- The Subscriptions Import API reads the entire file and then creates the subscription objects. This means the subscription objects can be in any order in the file.\n\n- Subscriptions imports are asynchronous and are processed one at a time. You can continue to send import requests, but these are queued. \n\n- The API works on a \"best endeavours\" approach. In other words, the API does its best to create the subscription objects based on the file that you provide. \n\n### Subscriptions Import File\n\nThe following table describes the subscriptions objects, and their attributes, that the import file can include.\n\n| Object | Attributes |\n| --- | --- |\n| A subscriber object | The attributes you specify for a subscriber object are the attributes you specify when [creating a subscriber](/docs/api/subscriptions/create-subscriber). |\n| An offering object | The attributes you specify for an offering object are the attributes you specify when [building an offering](/docs/api/subscriptions/build-offering). |\n", "item": [ { "id": "af78de00-1667-457f-9741-e8cdd0929268", "name": "Import a dataset", "request": { "name": "Import a dataset", "description": {}, "url": { "path": [ "v2", "subscriptions", "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The JSONL file you want to upload.", "type": "text/plain" }, "key": "import_file", "type": "file" }, { "description": { "content": "A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.", "type": "text/plain" }, "key": "external_ref", "value": "abc123", "type": "text" } ] }, "auth": null }, "response": [ { "id": "93eb8123-46ba-4111-843c-0e7589cfdd06", "name": "Success. The import was started.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "(Required) The JSONL file you want to upload.", "type": "text/plain" }, "key": "import_file", "type": "file" }, { "description": { "content": "A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.", "type": "text/plain" }, "key": "external_ref", "value": "abc123", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_import\",\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"finished_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"records\": {\n \"uploaded\": {\n \"subscription_feature\": 50000,\n \"subscription_subscriber\": 50000,\n \"subscription_offering\": 50000,\n \"subscription\": 50000\n },\n \"imported\": {\n \"subscription_feature\": 50000,\n \"subscription_subscriber\": 45090,\n \"subscription_offering\": 45090,\n \"subscription\": 45090\n }\n }\n },\n \"attributes\": {\n \"status\": \"pending\",\n \"external_ref\": \"abc123\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88992eab-41b8-4e5b-a601-47b6a85550fe", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "(Required) The JSONL file you want to upload.", "type": "text/plain" }, "key": "import_file", "type": "file" }, { "description": { "content": "A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.", "type": "text/plain" }, "key": "external_ref", "value": "abc123", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f31bbf8-7775-4c5b-bc5d-b168682896ee", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "(Required) The JSONL file you want to upload.", "type": "text/plain" }, "key": "import_file", "type": "file" }, { "description": { "content": "A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.", "type": "text/plain" }, "key": "external_ref", "value": "abc123", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55946871-4ef6-4496-b0e0-9c9734b28d22", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "(Required) The JSONL file you want to upload.", "type": "text/plain" }, "key": "import_file", "type": "file" }, { "description": { "content": "A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.", "type": "text/plain" }, "key": "external_ref", "value": "abc123", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c79d8879-fc98-41c2-b20c-4a0bff4e1ccf", "name": "List import jobs", "request": { "name": "List import jobs", "description": { "content": "Retrieves a list of all import jobs.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "03c3f7eb-44c7-49bb-8665-96577e7c6b6e", "name": "Success. A list of import jobs is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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 \"type\": \"subscription_import\",\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"finished_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"records\": {\n \"uploaded\": {\n \"subscription_feature\": 50000,\n \"subscription_subscriber\": 50000,\n \"subscription_offering\": 50000,\n \"subscription\": 50000\n },\n \"imported\": {\n \"subscription_feature\": 50000,\n \"subscription_subscriber\": 45090,\n \"subscription_offering\": 45090,\n \"subscription\": 45090\n }\n }\n },\n \"attributes\": {\n \"status\": \"pending\",\n \"external_ref\": \"abc123\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"type\": \"subscription_import\",\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"finished_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"records\": {\n \"uploaded\": {\n \"subscription_feature\": 50000,\n \"subscription_subscriber\": 50000,\n \"subscription_offering\": 50000,\n \"subscription\": 50000\n },\n \"imported\": {\n \"subscription_feature\": 50000,\n \"subscription_subscriber\": 45090,\n \"subscription_offering\": 45090,\n \"subscription\": 45090\n }\n }\n },\n \"attributes\": {\n \"status\": \"pending\",\n \"external_ref\": \"abc123\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\",\n \"key_2\": \"http://example.com/articles/1/comments\",\n \"key_3\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4373ec59-bee2-4d9d-8a2a-54207ad97685", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "imports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d312b0a-7812-4ef4-b600-e135a37fb849", "name": "Get import", "request": { "name": "Get import", "description": { "content": "Retrieves the import job for the specified ID.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "imports", ":import_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "import_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "be6a8977-02f9-4d3f-86f7-d948628e5d36", "name": "Success. The import is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "imports", ":import_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "import_uuid" } ] }, "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 \"type\": \"subscription_import\",\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"started_at\": \"2017-01-10T11:41:19.244842Z\",\n \"finished_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"records\": {\n \"uploaded\": {\n \"subscription_feature\": 50000,\n \"subscription_subscriber\": 50000,\n \"subscription_offering\": 50000,\n \"subscription\": 50000\n },\n \"imported\": {\n \"subscription_feature\": 50000,\n \"subscription_subscriber\": 45090,\n \"subscription_offering\": 45090,\n \"subscription\": 45090\n }\n }\n },\n \"attributes\": {\n \"status\": \"pending\",\n \"external_ref\": \"abc123\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ece4c59e-7be4-4886-8e28-f2674f7ba09a", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "imports", ":import_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "import_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28160097-0c3c-4579-b8a3-179a3ccefc29", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "imports", ":import_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "import_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f86cee74-2681-4ae5-a347-3376ac4e164c", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "imports", ":import_uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "import_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ec04209-5e9a-48f3-a07f-df3c1704cb2c", "name": "Get import errors", "request": { "name": "Get import errors", "description": { "content": "Retrieves all errors encountered as part of the import. Each error is attributed to a line in the JSONL file \nimported, so for example, if at line 1 in your JSONL you had a subscription_offering without a name, there would\nbe a minimum string error for the `name` attribute with `\"line_number\": 1`.\n\nErrors are also ordered by line number ascending, and can be paginated.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "imports", ":import_uuid", "errors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "import_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "331da53f-6dac-4176-85d6-f1a88438496a", "name": "Success. The import errors are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "imports", ":import_uuid", "errors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "import_uuid" } ] }, "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\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_import_error\",\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"error\": \"offering name cannot be empty\",\n \"field\": \"name\",\n \"line_number\": 123,\n \"external_ref\": \"abc123\"\n }\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_import_error\",\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"error\": \"offering name cannot be empty\",\n \"field\": \"name\",\n \"line_number\": 123,\n \"external_ref\": \"abc123\"\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8067ce1a-a69b-490f-a154-43dda80d7572", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "imports", ":import_uuid", "errors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "import_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fb0ac4c-a39c-4f42-8f7d-35912d9323db", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "imports", ":import_uuid", "errors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the import.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "import_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Schedules", "description": "You can schedule your billing, tax, and payment runs. By scheduling billing, tax, and payment runs, you automate the process, reducing manual intervention and ensuring the jobs are run in a timely manner. You can define a schedule in the format (`* * * * *`) which is a set of five fields in a line, indicating when a job should be executed. For example, you can define a schedule so that your job runs multiple times a day, or runs on specific days and months.\n\nSubscriptions runs on Coordinated Universal Time (UTC) time and conforms to [**RFC 3339**](https://www.rfc-editor.org/rfc/rfc3339). \n\n### Unrestricted fields\n\nSetting a field to an asterisk (`*`) is sometimes referred to as leaving a field unrestricted because it is not restricted to a specific value.\n\nYou can use the asterisk (`*`) to indicate the range of all values for the field. When you use the asterisk, the first value in the range is: 0 for the minute, hour, and day of the week (Sunday) fields, and 1 for day of the month and the month fields.\n\n### Configuring fields\n\nThe time fields have the following format and possible values and must be specified in the following order:\n\n| Field | Format | Description | \n| --- | --- | -----|\n| Minute | 0-59 | Indicates how far past the top of the hour your job runs, in minutes. For example if a minute is set to 0, then the job runs at the top of the hour because it is 0 minutes after the hour. This means if the hour is 8.00 AM, the job runs at 8.00 AM. |\n| Hour | 0-23 | Indicates how far past midnight your job runs, in hours. This is rounded down to the nearest hours. This is because minutes are indicated by the minute field. |\n| Day of the month | 0-31 | Indicates the calendar date of the month. For example, 1 for the first day of the month. |\n| Month | 1-12 or JAN to DEC | Indicates the month. Specify the month number or the first three letters of the month name in uppercase. For example, 1 or JAN for January. |\n| Day of the week | 0-6 (or SUN to SAT, or 7 for Sunday) | Indicates the day of the week. Monday is 1, Tuesday is 2, and so on. Either 0 or 7 indicates Sunday. Alternatively, specify the day of the week using the first three letters of the weekday name in uppercase. For example SUN for Sunday. If you use this field with the day of the month field, then this field is evaluated as an inclusive OR. For example, if the day of the month is set to 1 and the day of the week is set to SAT, the job runs on the first day of the month and on every Saturday of the month, even if the first day of the month is not a Saturday. If the day of the week is marked by an asterisk (*) then the field is marked as unrestricted. This means the job only runs on the first day of the month. |\n\n### Matching all values\n\nTo match all values for a field, set the field to an asterisk (`*`). When a field is set to an asterisk, the field matches all valid values for that field whenever the other field conditions are satisfied. \n\n Here are some examples.\n\n - `* 0 1 1 1`: the job runs every minute of the midnight hour on January 1st and Mondays.\n - `* * * * *`: the job runs every minute (of every hour, of every day of the month, of every month, every day of the week, because each of these is unrestricted).\n\n ### Matching a range\n\n To match a range of values, specify your start and stop values, separated by a hyphen (`-`). Do not include spaces in the range. Ranges are inclusive. The first number must be less than the second number. If you are using abbreviated names for the month or weekday (for example, JAN instead of 1 for the first month of the year), the first value must come earlier in the month or week than the second value.\n\nThe following equivalent examples run at midnight on Mondays, Tuesdays, Wednesdays, Thursdays, and Fridays (for all months):\n\n - `0 0 * * 1-5`\n - `0 0 * * MON-FRI`\n\n### Matching a list\n\nLists can contain any valid value for the field, including ranges. Specify your values, separated by a comma (,). Do not include spaces in the list.\n\nExamples:\n\n- `0 0,12 * * *`: the job runs at midnight and noon.\n- `0-5,30-35 * * * *`: the job runs in each of the first five minutes of every half hour (at the top of the hour and at half past the hour).\n\n### Skipping values in a range\n\nYou can skip values in a range by specifying a rate at which to step through the range. To do this, specify the range, followed by the forward slash (`/`) and the rate at which you want to skip through the range.\n\nThe step value cannot be larger than the largest possible value for the field. The default step is 1, so the step function `/1` is the same as not using a step function at all.\n\nExample ranges that use step functions:\n\n- `*/2`: this is a valid step function for any field. \n - For the minute field, it matches 0, 2, 4, ... , 58. \n - For the hour, it matches 0, 2, 4, ... , 22. \n - For the day of the month, it matches 1, 3, 5, ... , 31 (for a month with 31 days). \n - For the month, it matches 1, 3, 5, ... , 11. \n - For the day of the week, it matches 0, 2, 4, 6.\n\n- `0-12/2`: this is a valid step function for the minute and hour fields. It matches 0, 2, 4, ... , 12.\n\nExample schedules using step functions:\n\n- `*/2 * * * *`: the job runs every two minutes.\n- `0 0-12/2 * * *`: the job runs every two hours, on the hour. The first run is at midnight. The last run is at noon.\n", "item": [ { "id": "0c95bbb0-5639-4a39-9e14-b65b1ad76030", "name": "List schedules", "request": { "name": "List schedules", "description": { "content": "Retrieves a list of all schedules.\n\n### Filtering\n\nThis endpoint supports filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description |\n| --- | --- | --- | \n| `eq` | `external_ref` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |\n| `in` | `external_ref` | In. Checks if the value is in the specified list. If it is, the condition is true. |\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6a2fe369-f407-400d-8d7d-e55993d3138c", "name": "Success. A list of schedules is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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 \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"job\": {\n \"job_type\": \"billing-run\"\n },\n \"location\": \"Europe/London\",\n \"specification\": \"30 0 * * *\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"scheduled_for\": \"2017-07-21T17:32:28Z\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"job\": {\n \"job_type\": \"billing-run\"\n },\n \"location\": \"Europe/London\",\n \"specification\": \"30 0 * * *\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"scheduled_for\": \"2017-07-21T17:32:28Z\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46c35c33-dae2-4edc-a75b-6bb0a8629fe1", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b50fdc9-bbf4-4dc0-897e-cc306802240b", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b241794-593c-4186-8789-116f48bba6a2", "name": "Create a schedule", "request": { "name": "Create a schedule", "description": {}, "url": { "path": [ "v2", "subscriptions", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"specification\": \"30 0 * * *\",\n \"location\": \"Europe/London\",\n \"job\": {\n \"job_type\": \"billing-run\"\n },\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bd809c0f-8de4-4565-add0-9f4919f89069", "name": "Success. The schedule is created.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"specification\": \"30 0 * * *\",\n \"location\": \"Europe/London\",\n \"job\": {\n \"job_type\": \"billing-run\"\n },\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"job\": {\n \"job_type\": \"billing-run\"\n },\n \"location\": \"Europe/London\",\n \"specification\": \"30 0 * * *\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"scheduled_for\": \"2017-07-21T17:32:28Z\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc67700e-08d8-4004-8f1d-ea6da58d43ab", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"specification\": \"30 0 * * *\",\n \"location\": \"Europe/London\",\n \"job\": {\n \"job_type\": \"billing-run\"\n },\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b61248f-d710-4117-b0aa-6427330c2755", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"specification\": \"30 0 * * *\",\n \"location\": \"Europe/London\",\n \"job\": {\n \"job_type\": \"billing-run\"\n },\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ceb6d8a-8b70-4ef6-a044-7a5218192ae0", "name": "Get a schedule", "request": { "name": "Get a schedule", "description": {}, "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f477b292-b023-42fc-b33b-2481a406de40", "name": "Success. A schedule is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid" } ] }, "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 \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"job\": {\n \"job_type\": \"billing-run\"\n },\n \"location\": \"Europe/London\",\n \"specification\": \"30 0 * * *\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"scheduled_for\": \"2017-07-21T17:32:28Z\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9ed1448-4e1b-4b0e-b8e8-5c2bc32e3ef9", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "737784f4-64fd-44b5-89be-be33f320e965", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bc59979-28a0-4768-acb6-1b7d8c421506", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0a52cde-a68f-4050-99e2-afdcc9803c24", "name": "Update a schedule", "request": { "name": "Update a schedule", "description": {}, "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\",\n \"specification\": \"30 0 * * *\",\n \"location\": \"Europe/London\",\n \"job\": {\n \"job_type\": \"billing-run\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ebca7eec-22f5-4756-994c-e39cbb26d331", "name": "Success. The schedule details are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\",\n \"specification\": \"30 0 * * *\",\n \"location\": \"Europe/London\",\n \"job\": {\n \"job_type\": \"billing-run\"\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 \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"job\": {\n \"job_type\": \"billing-run\"\n },\n \"location\": \"Europe/London\",\n \"specification\": \"30 0 * * *\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"scheduled_for\": \"2017-07-21T17:32:28Z\"\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44f48d6c-5932-4b5e-8007-b2e238b5be1c", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\",\n \"specification\": \"30 0 * * *\",\n \"location\": \"Europe/London\",\n \"job\": {\n \"job_type\": \"billing-run\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6173970c-4887-4dc9-b4fa-7857475414fa", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\",\n \"specification\": \"30 0 * * *\",\n \"location\": \"Europe/London\",\n \"job\": {\n \"job_type\": \"billing-run\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84e6d07c-b917-4c8f-8a86-e00aca8d24d3", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\",\n \"specification\": \"30 0 * * *\",\n \"location\": \"Europe/London\",\n \"job\": {\n \"job_type\": \"billing-run\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6cd962a-b4c0-4a19-8681-1b6b2d1a10d2", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\",\n \"specification\": \"30 0 * * *\",\n \"location\": \"Europe/London\",\n \"job\": {\n \"job_type\": \"billing-run\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03bbb104-b711-4c74-84d6-edc60a4d77fd", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_schedule\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Daily billing run.\",\n \"specification\": \"30 0 * * *\",\n \"location\": \"Europe/London\",\n \"job\": {\n \"job_type\": \"billing-run\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc963779-3ac2-4a84-ac6d-a31f0dc3dd57", "name": "Delete schedule", "request": { "name": "Delete schedule", "description": {}, "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "0e2c2383-9915-466c-99dc-eeaa790e5391", "name": "Success. The schedule is removed.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid" } ] }, "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": "3205cd32-04ee-4ab2-9bfb-c99e2f14c918", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a966998-abf7-4674-be48-da35df3609fe", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "schedules", ":schedule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the schedule.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "schedule_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Subscribers", "description": "A subscriber is someone who subscribes to your plan or service.\n", "item": [ { "id": "eb40c145-7e37-401e-baa2-c5f824b60b33", "name": "List subscribers", "request": { "name": "List subscribers", "description": { "content": "Retrieves a list of all subscribers.\n\n### Filtering\n\nThis endpoint supports filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description |\n| --- | --- | --- | \n| `eq` | `account_id`, `name`, `email`, `external_ref` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |\n| `in` | `account_id`, `name`, `email`, `external_ref` | In. Checks if the value is in the specified list. If it is, the condition is true. |\n| `like` | `name`, `email` | Partial match (case-sensitive). Use `*` at the start, end, or both to match any sequence of characters (e.g. `*substring`, `substring*`, `*substring*`). |\n| `ilike` | `name`, `email` | Partial match (case-insensitive). Same as `like` but matching ignores case. Use `*` at the start, end, or both to match any sequence of characters. |\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "604984ff-875b-45fb-967d-5fff0cbe742a", "name": "Success. A list of subscribers is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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 \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"feature_entitlements\": [\n \"tag1\",\n \"tag2\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"feature_entitlements\": [\n \"tag1\",\n \"tag2\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4109cd6-9c02-4fa9-ad4d-575e8b59729e", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed10b080-e839-47c9-9918-e7ee1d426c87", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac5eedef-f3ca-4265-a6f9-799c0daf55f2", "name": "Create a subscriber", "request": { "name": "Create a subscriber", "description": {}, "url": { "path": [ "v2", "subscriptions", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e8584ce7-af2e-4570-b076-90006bbb6477", "name": "Success. The subscriber is created.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"feature_entitlements\": [\n \"tag1\",\n \"tag2\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e756893-7dc8-4ed2-bee4-4724209771ec", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fde62d8-2ad9-45cc-b62b-f90cf298a96a", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" } ], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1927dc90-39e8-4c47-91cd-dd0932e03783", "name": "Get a subscriber", "request": { "name": "Get a subscriber", "description": {}, "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e78b746f-fe20-4bf7-b38b-21c4b9dcbb29", "name": "Success. A subscriber is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid" } ] }, "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 \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"feature_entitlements\": [\n \"tag1\",\n \"tag2\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b373c62-01a0-4a34-8a4e-323ed4937985", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3161f88-6c47-4cb0-9617-7c37cc0de7e8", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24f27d05-3a9a-4fa6-8550-5e824454881e", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "feff2b5f-e880-4c06-82ea-43281c9a019c", "name": "Update a subscriber", "request": { "name": "Update a subscriber", "description": {}, "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5d68a6bc-274c-434f-aec9-4ab7e97335b6", "name": "Success. The subscriber details are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\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 \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"account_id\": \"11111111-2222-3333-4444-555555555555\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"feature_entitlements\": [\n \"tag1\",\n \"tag2\"\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f006c5f3-63b1-4852-80d1-d313541cb7e4", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b7981ed-66fc-4546-bc29-98a473b5fd65", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcb09157-ded6-44ae-9d4e-997e733e68a5", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee4bef2b-1323-4d30-90ff-82a566dfdb22", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65a5683c-c22c-4b2d-93b0-a0b6e0e5ccde", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_subscriber\",\n \"attributes\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"payment_authority\": {\n \"type\": \"elastic_path_payments_stripe\",\n \"customer_id\": \"cus_OPfKlxWV3hp9h6\",\n \"card_id\": \"card_8Diw3FQPhxK27WADPVMeXieP\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cebd4fb1-9b14-4823-b59b-e7367f0b2685", "name": "Delete subscriber", "request": { "name": "Delete subscriber", "description": {}, "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "6681394e-4b30-4214-ab2d-b31cb160563b", "name": "Success. The subscriber is removed.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid" } ] }, "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": "80462a17-e7a2-43e9-bab1-2348ac5a7b0d", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09f07ee1-e0c7-48dd-a012-38a65bc282d5", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "subscribers", ":subscriber_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the subscriber.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "subscriber_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Invoices", "description": "Invoices represent the amount a customer owes for a subscription. Elastic Path Subscriptions generates an invoice for every period in a subscription billing cycle. Invoices provide:\n\n- an itemized list of goods and services provided by a subscription.\n- the cost of a subscription.\n- if applicable, any taxes.\n\nThe invoice lifecycle is described below.\n\n1. When a subscription is created, an invoice for the first billing period is created. When a subscription is created as part of an order, the payment for the order covers the first billing period.\n2. Subscription invoices are created by [**billing runs**](/docs/api/subscriptions/jobs). The billing run identifies subscriptions that require a new invoice for their next billing period and creates them. At this point, invoices are marked as outstanding.\n3. Invoices where `tax_required` is `true` will not have payment taken until a tax run has added the required tax to the invoice. \n3. The [**payment run**](/docs/api/subscriptions/jobs) identifies invoices that are still outstanding and attempts to take payment for them. If the payment succeeds the the invoice is no longer outstanding. If the payment fails for any reason, then the invoice remains outstanding and is picked up by the next payment run to retry the payment. If an invoice has a failed payment, payment is only retried if the fixed interval has passed from the last payment attempt as defined in Settings.\n\n### Payment Retries\n\nIt is important to limit the number of times Subscriptions retries a failed payment request for many reasons, including: frequent payment retries can indicate fraudulent activities; multiple failed payment attempts can lead to customers accounts being locked out or flagged for suspicious activity resulting in poor customer experience; and excessive retries places an unnecessary load on your payment processing system.\n\nIn Subscriptions, by default, the number of payment retries is 10. You can set this to a limit between 0 - 20, depending on your requirements. Each payment retry is made as a payment run. \n\nOnce the number of payment retries reaches the limit, the payment retries stop, resulting in status of the invoice being unpaid. See [Invoices](#invoices).\n\nWhen configuring payment retries, you have the following options.\n\n| Attribute | Required | Description |\n| --- | --- | --- |\n| `payment_retry_type` | Optional | One of the following options:
  • `fixed` - use `fixed` if you want a fixed time interval between payment retries.
  • `backoff` - use `backoff` if you want the time between retry attempts to increase exponentially.
  • `tiered` - use `tiered` if you want to specify a list of time durations.
|\n| `payment_retry_interval` | Optional | Represents the retry interval. For example, if `payment_retry_unit` is `week` and `payment_retry_interval` is `1` then, the payment retry interval is 1 week. |\n| `payment_retry_multiplier` | Optional | Use when `payment_retry_type` is `tiered` and represents the factor by which the time duration increases after each retry. |\n| `payment_retry_unit` | Optional | Represents the unit of time, either `day` or `week`. |\n\n### Rounding\n\nSubscriptions always rounds down to the penny. \n\n### Tax\n\nSubscriptions allows you to apply any number of tax rates to your invoices and subscriptions. When applying a tax rate, you must specify:\n\n- a name that appears on your customer's invoice that describes the specific type of tax.\n- the tax rate which is the percentage of the subscription amount that is required to be paid as tax.\n\nIn addition, you can optionally specify the jurisdiction which is the geographic area or political entity that has authority to levey and collect taxes.\n\nYou can apply more than one tax rate for all items in an invoice. You cannot apply a tax rate per line item.\n\n### Payments\n\nWhen your customers add a subscription to a cart and the cart is checked out, an unpaid order is returned. You can process the payment for the order though a payment gateway. You can do this using:\n\n- Elastic Path Payments Powered by Stripe. The Elastic Path Payments Powered by Stripe gateway interacts with Stripe to allow your subscribers to pay for their subscriptions. \n- Authorize.Net. \n\n#### Using Elastic Path Payments Powered by Stripe\n\nTo use Elastic Path Payments Powered by Stripe gateway, contact the [**Customer Success Team**](mailto:customersuccess@elasticpath.com). \n\nCreate your Stripe account in [**Stripe Dashboard**](https://dashboard.stripe.com/login) and complete an onboarding form to make payments using the gateway. For more information, see [**Onboarding**](/docs/payments/onboarding).\n\nOnce you have signed up for Elastic Path Payments Powered by Stripe, you must configure the payment gateway so that your shoppers can make payments. See [**Configure Elastic Path Payments Powered by Stripe**](/docs/payments/onboarding).\n\n#### Using Authorize.Net\n\nTo use Authorize.Net, you must have: \n\n- an active merchant account with Authorize.Net\n- obtained API credentials. These include an **API Login ID** and a **Transaction Key**.\n- Enabled Authorize.Net in Commerce Manager. See [Enabling Authorize.net](/docs/commerce-manager/payments/configure-other-payment-gateways#enabling-authorizenet).\n\n#### Payment Requests\n\nSubscriptions only supports the `purchase` payment mechanism. The gateway attempts to charge the customer immediately, and the result of the attempt is returned. If a payment fails, the invoice is kept as outstanding and the payment information, with the reason for the failure is attached to the invoice. A new payment run is required to attempt another payment. \n\nWhen sending a payment request to the Payments service, you must specify the following.\n\n| Attribute | Required | Description |\n| --- | --- | --- |\n| `gateway` | Required| One of `elastic_path_payments_stripe`, `authorize_net` and `stripe_payment_intents`. |\n| `method` | Required | Must be `purchase`.\n| `payment` | Required | The type of payment, for example, `pm_card_visa_debit`.\n| `options` | Required | These options must be set as they set up the card to be used in future without the customer being present. If these options are not set, future payments may fail. There are two options.
  • `off_session`. Must be set to `true`.
  • `confirm`. Must be set to `true`.
|\n\n#### External Payments\n\nExternal payments are payment methods not offered by Elastic Path Subscriptions (such as Elastic Path Payments powered by Stripe or Authorize.net), but they can still be integrated with Subscriptions. To do this, you must configure your subscriptions to use external payments by setting `manual_payments` to `true`. See [Create a Subscription](/docs/api/subscriptions/create-subscription).\n\nWhen a subscription is created with `manual_payments` set to `true`:\n\n1. When the payment run processes the generated invoice, it creates a pending payment. A `subscription-invoice-created` event is emitted that includes the `subscription_id`, `invoice_id` and `payment_id`. No payment is taken. \n2. You can use the events generated by Elastic Path Subscriptions to configure your external payment system to respond to these events, ensuring that your external payment system knows when the payment schedule has run and it's time to process the payment.\n3. When the external payment system handles the payment (either takes the payment successfully or the payment fails) the [Update Invoice Payment](/docs/api/subscriptions/update-invoice-payment) endpoint, enables the update of the pending payment. \n - If payment is successful, the invoice is updated to `paid` and the billing/payment cycle continues as normal.\n - If payment fails, the invoice continues to be marked as `outstanding`. The payment is not `pending` anymore. This is because a payment attempt has been made. Following on from this, the next payment run generates another manual pending payment. The external system is notified of this using the `subscription-invoice-payment-updated`.\n\n#### Card Declines\n\nCard payments can fail for a variety of reasons, including insufficient funds, incorrect card data or fraudulent activity. You can use the `card_id` and `customer_id` attributes to program your front-end implementation to allow your preferred payment service provider to update a subscription with new card details, enabling you to easily manage your subscription changes.\n", "item": [ { "id": "6554bbb5-69cb-40c2-84bf-086027f8f502", "name": "List invoices", "request": { "name": "List invoices", "description": { "content": "Retrieves a list of all invoices.\n\n### Filtering\n\nThis endpoint supports filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator |Attribute | Description |\n| --- | --- | --- | \n| `eq` | `subscriber_id`, `subscription_id`, `outstanding`, `tax_required` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |\n| `in` | `subscriber_id`, `subscription_id` | In. Checks if the value is in the specified list. If it is, the condition is true. |\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "88574c55-b663-4ad1-820a-c784e4dc22f1", "name": "Success. A list of invoices is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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 \"type\": \"subscription_invoice\",\n \"attributes\": {\n \"billing_period\": {\n \"start\": \"2017-07-21T17:32:28Z\",\n \"end\": \"2017-07-21T17:32:28Z\"\n },\n \"pro_forma\": false,\n \"invoice_items\": [\n {\n \"description\": \"Magazine issue\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"from_time_period\": \"2017-01-10T11:41:19.244842Z\",\n \"until_time_period\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"description\": \"Magazine issue\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"from_time_period\": \"2017-01-10T11:41:19.244842Z\",\n \"until_time_period\": \"2017-01-10T11:41:19.244842Z\"\n }\n ],\n \"outstanding\": true,\n \"tax_required\": true,\n \"payment_retries_limit_reached\": false,\n \"manual_payment_pending\": true,\n \"tax_items\": [\n {\n \"type\": \"tax_item\",\n \"rate\": 0.2,\n \"name\": \"GST\",\n \"code\": \"20.0 % S\",\n \"jurisdiction\": \"USA\"\n },\n {\n \"type\": \"tax_item\",\n \"rate\": 0.2,\n \"name\": \"GST\",\n \"code\": \"20.0 % S\",\n \"jurisdiction\": \"USA\"\n }\n ],\n \"number\": 1,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"valid_from\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"taxes_added_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"proration_events\": [\n {\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"billing_cost_before_proration\": 100,\n \"refunded_amount_for_unused_pricing_option\": 100,\n \"new_pricing_option_cost\": 100,\n \"prorated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"billing_cost_before_proration\": 100,\n \"refunded_amount_for_unused_pricing_option\": 100,\n \"new_pricing_option_cost\": 100,\n \"prorated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n ],\n \"pro_rata_remaining_value\": 500,\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"subscription_id\": \"11111111-2222-3333-4444-555555555555\",\n \"subscriber_id\": \"11111111-2222-3333-4444-555555555555\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"notifications\": [\n {\n \"name\": \"7 days before renewal\",\n \"due\": \"2024-01-24T00:00:00Z\",\n \"sent_at\": \"2024-01-24T00:00:00Z\"\n },\n {\n \"name\": \"7 days before renewal\",\n \"due\": \"2024-01-24T00:00:00Z\",\n \"sent_at\": \"2024-01-24T00:00:00Z\"\n }\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"type\": \"subscription_invoice\",\n \"attributes\": {\n \"billing_period\": {\n \"start\": \"2017-07-21T17:32:28Z\",\n \"end\": \"2017-07-21T17:32:28Z\"\n },\n \"pro_forma\": false,\n \"invoice_items\": [\n {\n \"description\": \"Magazine issue\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"from_time_period\": \"2017-01-10T11:41:19.244842Z\",\n \"until_time_period\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"description\": \"Magazine issue\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"from_time_period\": \"2017-01-10T11:41:19.244842Z\",\n \"until_time_period\": \"2017-01-10T11:41:19.244842Z\"\n }\n ],\n \"outstanding\": true,\n \"tax_required\": true,\n \"payment_retries_limit_reached\": false,\n \"manual_payment_pending\": true,\n \"tax_items\": [\n {\n \"type\": \"tax_item\",\n \"rate\": 0.2,\n \"name\": \"GST\",\n \"code\": \"20.0 % S\",\n \"jurisdiction\": \"USA\"\n },\n {\n \"type\": \"tax_item\",\n \"rate\": 0.2,\n \"name\": \"GST\",\n \"code\": \"20.0 % S\",\n \"jurisdiction\": \"USA\"\n }\n ],\n \"number\": 1,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"valid_from\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"taxes_added_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"proration_events\": [\n {\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"billing_cost_before_proration\": 100,\n \"refunded_amount_for_unused_pricing_option\": 100,\n \"new_pricing_option_cost\": 100,\n \"prorated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"billing_cost_before_proration\": 100,\n \"refunded_amount_for_unused_pricing_option\": 100,\n \"new_pricing_option_cost\": 100,\n \"prorated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n ],\n \"pro_rata_remaining_value\": 500,\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"subscription_id\": \"11111111-2222-3333-4444-555555555555\",\n \"subscriber_id\": \"11111111-2222-3333-4444-555555555555\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"notifications\": [\n {\n \"name\": \"7 days before renewal\",\n \"due\": \"2024-01-24T00:00:00Z\",\n \"sent_at\": \"2024-01-24T00:00:00Z\"\n },\n {\n \"name\": \"7 days before renewal\",\n \"due\": \"2024-01-24T00:00:00Z\",\n \"sent_at\": \"2024-01-24T00:00:00Z\"\n }\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82127382-7517-4b12-92d8-157100356671", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "951b51fc-e0ed-4f8f-8d99-c15f64215fbe", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "befb5f3a-b9b2-4356-941f-2460684ddfaf", "name": "Get invoice", "request": { "name": "Get invoice", "description": {}, "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4cc16b40-026a-46ed-aacb-179cda079c19", "name": "Success. The details of the invoice are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" } ] }, "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 \"type\": \"subscription_invoice\",\n \"attributes\": {\n \"billing_period\": {\n \"start\": \"2017-07-21T17:32:28Z\",\n \"end\": \"2017-07-21T17:32:28Z\"\n },\n \"pro_forma\": false,\n \"invoice_items\": [\n {\n \"description\": \"Magazine issue\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"from_time_period\": \"2017-01-10T11:41:19.244842Z\",\n \"until_time_period\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"description\": \"Magazine issue\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"plan_id\": \"11111111-2222-3333-4444-555555555555\",\n \"from_time_period\": \"2017-01-10T11:41:19.244842Z\",\n \"until_time_period\": \"2017-01-10T11:41:19.244842Z\"\n }\n ],\n \"outstanding\": true,\n \"tax_required\": true,\n \"payment_retries_limit_reached\": false,\n \"manual_payment_pending\": true,\n \"tax_items\": [\n {\n \"type\": \"tax_item\",\n \"rate\": 0.2,\n \"name\": \"GST\",\n \"code\": \"20.0 % S\",\n \"jurisdiction\": \"USA\"\n },\n {\n \"type\": \"tax_item\",\n \"rate\": 0.2,\n \"name\": \"GST\",\n \"code\": \"20.0 % S\",\n \"jurisdiction\": \"USA\"\n }\n ],\n \"number\": 1,\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"valid_from\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"taxes_added_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"proration_events\": [\n {\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"billing_cost_before_proration\": 100,\n \"refunded_amount_for_unused_pricing_option\": 100,\n \"new_pricing_option_cost\": 100,\n \"prorated_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n {\n \"proration_policy_id\": \"11111111-2222-3333-4444-555555555555\",\n \"billing_cost_before_proration\": 100,\n \"refunded_amount_for_unused_pricing_option\": 100,\n \"new_pricing_option_cost\": 100,\n \"prorated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n ],\n \"pro_rata_remaining_value\": 500,\n \"display_price\": {\n \"without_tax\": {\n \"amount\": 100,\n \"currency\": \"USD\",\n \"formatted\": \"$1.00\"\n },\n \"with_tax\": {\n \"amount\": 110,\n \"currency\": \"USD\",\n \"formatted\": \"$1.10\"\n },\n \"tax\": {\n \"amount\": 10,\n \"currency\": \"USD\",\n \"formatted\": \"$0.10\"\n }\n },\n \"subscription_id\": \"11111111-2222-3333-4444-555555555555\",\n \"subscriber_id\": \"11111111-2222-3333-4444-555555555555\",\n \"price\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"notifications\": [\n {\n \"name\": \"7 days before renewal\",\n \"due\": \"2024-01-24T00:00:00Z\",\n \"sent_at\": \"2024-01-24T00:00:00Z\"\n },\n {\n \"name\": \"7 days before renewal\",\n \"due\": \"2024-01-24T00:00:00Z\",\n \"sent_at\": \"2024-01-24T00:00:00Z\"\n }\n ]\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_2\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9644c062-8ec7-4f0d-afca-15471afde31f", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eae7929-eb45-4d04-b0fc-4241df5e8dd6", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaa03977-f1f7-4331-880f-9b8867a5b30c", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b81172e-7811-4487-8d94-151202e42b68", "name": "List invoice payments", "request": { "name": "List invoice payments", "description": {}, "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a5fdbbc0-e896-4f52-a333-849297d16a1e", "name": "Success. Payments for the invoice are returned", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" } ] }, "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\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment\",\n \"attributes\": {\n \"success\": true,\n \"amount\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"gateway\": \"elastic_path_payments_stripe\",\n \"pending\": true,\n \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"failure_detail\": {\n \"reason\": \"Card Failure\"\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"invoice_id\": \"11111111-2222-3333-4444-555555555555\",\n \"subscription_id\": \"11111111-2222-3333-4444-555555555555\",\n \"job_id\": \"11111111-2222-3333-4444-555555555555\",\n \"manual_payment\": false\n }\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment\",\n \"attributes\": {\n \"success\": true,\n \"amount\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"gateway\": \"elastic_path_payments_stripe\",\n \"pending\": true,\n \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"failure_detail\": {\n \"reason\": \"Card Failure\"\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"invoice_id\": \"11111111-2222-3333-4444-555555555555\",\n \"subscription_id\": \"11111111-2222-3333-4444-555555555555\",\n \"job_id\": \"11111111-2222-3333-4444-555555555555\",\n \"manual_payment\": false\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "27e83dd7-0acb-47a2-98f3-c19872b80be8", "name": "Get invoice payment", "request": { "name": "Get invoice payment", "description": {}, "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2fbccd25-987b-46cb-a852-919ec229f726", "name": "Success. Specific payment for the invoice is returned", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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 \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment\",\n \"attributes\": {\n \"success\": true,\n \"amount\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"gateway\": \"elastic_path_payments_stripe\",\n \"pending\": true,\n \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"failure_detail\": {\n \"reason\": \"Card Failure\"\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"invoice_id\": \"11111111-2222-3333-4444-555555555555\",\n \"subscription_id\": \"11111111-2222-3333-4444-555555555555\",\n \"job_id\": \"11111111-2222-3333-4444-555555555555\",\n \"manual_payment\": false\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebff76b9-7098-4cdb-a136-23def155d360", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b161b95-b801-492e-8302-8c3e2b4615d4", "name": "Update Invoice Payment", "request": { "name": "Update Invoice Payment", "description": { "content": "External payment methods are payment methods not offered by Elastic Path Subscriptions (such as Elastic Path Payments powered by Stripe or Authorize.net), but they can still be integrated with Subscriptions. You can use the `Update Invoice Payment` endpoint to manually update a payment against an invoice where an external payment method is handling the payment of your invoices. See [External Payments](/docs/api/subscriptions/invoices#external-payments).\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment\",\n \"attributes\": {\n \"success\": true,\n \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"failure_detail\": \"Card Failure\",\n \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8aaf13a7-4047-4078-a6d7-910075a7c810", "name": "Success. Invoice payment has been updated.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment\",\n \"attributes\": {\n \"success\": true,\n \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"failure_detail\": \"Card Failure\",\n \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment\",\n \"attributes\": {\n \"success\": true,\n \"amount\": {\n \"currency\": \"USD\",\n \"amount\": 100,\n \"includes_tax\": false\n },\n \"gateway\": \"elastic_path_payments_stripe\",\n \"pending\": true,\n \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"failure_detail\": {\n \"reason\": \"Card Failure\"\n }\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\",\n \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"invoice_id\": \"11111111-2222-3333-4444-555555555555\",\n \"subscription_id\": \"11111111-2222-3333-4444-555555555555\",\n \"job_id\": \"11111111-2222-3333-4444-555555555555\",\n \"manual_payment\": false\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca3e6dd1-61da-4968-af11-877e1eba18b1", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment\",\n \"attributes\": {\n \"success\": true,\n \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"failure_detail\": \"Card Failure\",\n \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd8a17fb-de0c-40e9-92b7-c36d8c93586a", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment\",\n \"attributes\": {\n \"success\": true,\n \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"failure_detail\": \"Card Failure\",\n \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fbe8347-de85-44ba-853e-d47e4e9c8090", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment\",\n \"attributes\": {\n \"success\": true,\n \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"failure_detail\": \"Card Failure\",\n \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac4ccfe1-26b6-418c-b227-a41fff39f3d9", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment\",\n \"attributes\": {\n \"success\": true,\n \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"failure_detail\": \"Card Failure\",\n \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce7af671-e2eb-4313-8aad-62ab24f79a80", "name": "Create a refund for an invoice payment", "request": { "name": "Create a refund for an invoice payment", "description": { "content": "Creates a refund for a paid invoice.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_invoice_payment_refund\",\n \"attributes\": {\n \"amount\": 100,\n \"reason\": \"Customer requested cancellation\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "88f0cfc3-6e64-4dcd-a160-cbd690b9a2af", "name": "Success. The payment refund is completed.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_invoice_payment_refund\",\n \"attributes\": {\n \"amount\": 100,\n \"reason\": \"Customer requested cancellation\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment_refund\",\n \"attributes\": {\n \"amount\": 100,\n \"reason\": \"Customer requested cancellation\",\n \"gateway\": \"elastic_path_payments_stripe\",\n \"external_refund_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cccd23f-0738-4ed9-84d4-491fd3186544", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_invoice_payment_refund\",\n \"attributes\": {\n \"amount\": 100,\n \"reason\": \"Customer requested cancellation\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d7765d6-087e-47fa-99f6-4e34c1302e31", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_invoice_payment_refund\",\n \"attributes\": {\n \"amount\": 100,\n \"reason\": \"Customer requested cancellation\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e9be6af-2af4-4499-92c4-af12a90671da", "name": "Unprocessable Content.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_invoice_payment_refund\",\n \"attributes\": {\n \"amount\": 100,\n \"reason\": \"Customer requested cancellation\"\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 \"errors\": [\n {\n \"title\": \"Unprocessable Content\",\n \"status\": \"422\",\n \"detail\": \"Unprocessable Content: cannot process the refund\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0455ca77-88a1-4b33-843e-332bdc291149", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_invoice_payment_refund\",\n \"attributes\": {\n \"amount\": 100,\n \"reason\": \"Customer requested cancellation\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "634e3879-6682-48e1-993d-752ad4e981b4", "name": "List invoice payment refunds", "request": { "name": "List invoice payment refunds", "description": { "content": "List all refunds for an invoice payments", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9c9d68cd-c813-4a46-88f5-65aa2fd218c3", "name": "Success. Refunds for an invoice payment are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment_refund\",\n \"attributes\": {\n \"amount\": 100,\n \"reason\": \"Customer requested cancellation\",\n \"gateway\": \"elastic_path_payments_stripe\",\n \"external_refund_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n },\n {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment_refund\",\n \"attributes\": {\n \"amount\": 100,\n \"reason\": \"Customer requested cancellation\",\n \"gateway\": \"elastic_path_payments_stripe\",\n \"external_refund_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\",\n \"key_2\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d966045a-6752-43d7-9eba-d9713cd1709d", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c2598ab-7129-4a29-933f-0b45dc4f9463", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "391bafb6-ad7d-4200-ba22-66b1613bec21", "name": "Get a refund for an invoice payment", "request": { "name": "Get a refund for an invoice payment", "description": { "content": "Get a refund for a paid invoice.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds", ":refund_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" } }, { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "refund_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of the refund.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7c8f0377-cf1c-4320-b009-fd81aa2936cb", "name": "Success. Specific refund for the invoice payment is returned", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds", ":refund_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the refund.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "refund_uuid" } ] }, "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 \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_invoice_payment_refund\",\n \"attributes\": {\n \"amount\": 100,\n \"reason\": \"Customer requested cancellation\",\n \"gateway\": \"elastic_path_payments_stripe\",\n \"external_refund_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n \"created_at\": \"2017-01-10T11:41:19.244842Z\"\n },\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"11111111-2222-3333-4444-555555555555\"\n },\n \"links\": {\n \"related\": \"foo.bar\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94ce3e44-4bc4-4015-987a-a58bb9a7759a", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds", ":refund_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the refund.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "refund_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ae605f5-7f4b-4929-8644-4457bc0a4b58", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds", ":refund_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the refund.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "refund_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48ce624e-d9ee-4517-b6b5-0d142523c265", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "invoices", ":invoice_uuid", "payments", ":payment_uuid", "refunds", ":refund_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the invoice.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "invoice_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the payment.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "payment_uuid" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the refund.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "refund_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Dunning Rules", "description": "\nDunning is the process of handling failed payment attempts. This is important for recovering revenue from failed payments, reduces customer churn and maintains cashflow. By implementing efficient dunning processes, you can enhance financial health and operational efficiency.\n\nSubscriptions enables you to create a dunning rule that allows you to configure payment retry schedules. Subscriptions retries failed payments automatically. You can customize the timing and frequency of the payment retries.\n\nDunning is enabled by default. You can choose to disable dunning. If no dunning rule is configured, then payment is retried once a day for 10 days, in total 11 payments. You can decide what action to take after the Subscriptions has stopped retrying the payments.\n\n- Do nothing - the subscription remains active and Subscriptions does not attempt to retry the payment. However, the subscription is still available for a subscriber to use.\n- Suspend the subscription. Subscriptions does not attempt to retry the payment. A subscriber can choose to pay the outstanding invoice. However, a subscriber cannot renew their subscription; a merchandizer must renew the subscription on behalf of the subscriber.\n- close a subscription. The subscription ends and it's status becomes `inactive`. However, a merchandizer can choose to resume the subscription if a subscriber pays the outstanding payment. \n", "item": [ { "id": "73419e32-1e30-4832-a0a0-cad1ca183d37", "name": "Create a dunning rule", "request": { "name": "Create a dunning rule", "description": { "content": "Dunning rules must use a `fixed` strategy. This means payments are retried on a fixed schedule. \n\nWhen an invoice is created, it immediately becomes eligible for payment by the next payment run. If the first payment attempt fails then the invoice enters dunning. In subsequent payment runs, invoices are only considered for payment if they meet the dunning rules you create.\n\nYou can configure a dunning rule to be the default for your store. There can only be one default rule per store. All invoices in your store will then perform dunning according to the specified rules. \n\n:::note\nIf no dunning rule is configured, then payment is retried once a day for 10 days, in total 11 payments. You can decide what action to take after the Subscriptions has stopped retrying the payments.\n:::\n\nThe following attributes are used to define a `fixed` schedule:\n\n- `payment_retry_unit - the unit of time used to measure the intervals between payment attempts or retries. \n- `payment_retry_interval` - the number of `payment_interval-units` to wait between each payment retry attempt.\n- `payment_retries_limit` - the number of times subscriptions attempts payments retries before an `action` is taken.\n- `action` - the action to take if payment is not successful.\n\nFor example, if:\n\n- the `payment_retry_unit` is `days` \n- the `payment_retry_interval` is `2`\n- the `payment_rety_limit` is `10`\n- the `action` is `close`.\n\nSubscriptions attempts to retry the payment every 2 days until 10 payment attempts have been tried. At that point, the subscription ends and it's status changes to `inacive`. \n\nFollowing on from this, you can specify that the dunning rule is no longer the default. You do not have to specify another rule to replace it. If you do remove the default dunning rule, the store defaults to the behavior that is followed when dunning is not enabled.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "dunning-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_unit\": \"day\",\n \"payment_retry_interval\": 1,\n \"payment_retries_limit\": 10,\n \"action\": \"none\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3acadf20-ec39-40b9-ac8b-eba9cafdb89a", "name": "Success. The dunning rule set is created.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_unit\": \"day\",\n \"payment_retry_interval\": 1,\n \"payment_retries_limit\": 10,\n \"action\": \"none\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_unit\": \"day\",\n \"payment_retry_interval\": 1,\n \"payment_retries_limit\": 10,\n \"action\": \"none\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2414819-f23e-4cda-8601-4ad823455582", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_unit\": \"day\",\n \"payment_retry_interval\": 1,\n \"payment_retries_limit\": 10,\n \"action\": \"none\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "444a5018-9e0a-4cbb-85b1-76d82bd65774", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_unit\": \"day\",\n \"payment_retry_interval\": 1,\n \"payment_retries_limit\": 10,\n \"action\": \"none\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "00d54291-c992-48be-96dd-879035991357", "name": "List dunning rules", "request": { "name": "List dunning rules", "description": { "content": "Retrieves a list of all dunning rule sets.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "dunning-rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "967783f8-529c-4615-83de-8eb4384d4df3", "name": "Success. A list of dunning rules is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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 \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_unit\": \"day\",\n \"payment_retry_interval\": 1,\n \"payment_retries_limit\": 10,\n \"action\": \"none\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_unit\": \"day\",\n \"payment_retry_interval\": 1,\n \"payment_retries_limit\": 10,\n \"action\": \"none\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\",\n \"key_1\": \"http://example.com/articles/1/comments\",\n \"key_2\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5464f9a-5699-4959-bb9a-82da88b28f54", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "342c0f5f-7f9c-453a-a6e0-01f64c10cafa", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "eq(name,Alan Turing)" }, { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2af07ed-cf31-4d89-aaf4-2610bddee117", "name": "Get dunning rule policy", "request": { "name": "Get dunning rule policy", "description": {}, "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0c7ebea0-3ddd-463a-a55d-191d0a9cbb4f", "name": "Success. The dunning rule details are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid" } ] }, "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 \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_unit\": \"day\",\n \"payment_retry_interval\": 1,\n \"payment_retries_limit\": 10,\n \"action\": \"none\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c03d3110-24bb-4c0b-a4db-3541553b254d", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe11b149-9cd0-40fb-86e8-d8b2b03c7361", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6be1c4f1-b9e5-4690-8222-8feead4f20b4", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6e381fb-ca06-4ef6-bed3-96931f2c6773", "name": "Update dunning rule policy", "request": { "name": "Update dunning rule policy", "description": { "content": "Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the rule is not updated. For fields that are optional, an existing value can be removed by specifying a value of null.", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_interval\": 1,\n \"payment_retry_unit\": \"day\",\n \"payment_retry_multiplier\": 1,\n \"payment_retries_limit\": 5,\n \"action\": \"none\",\n \"default\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0315022f-1166-4085-ad06-ddbe981d8f16", "name": "Success. The dunning rule set has been updated.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_interval\": 1,\n \"payment_retry_unit\": \"day\",\n \"payment_retry_multiplier\": 1,\n \"payment_retries_limit\": 5,\n \"action\": \"none\",\n \"default\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_unit\": \"day\",\n \"payment_retry_interval\": 1,\n \"payment_retries_limit\": 10,\n \"action\": \"none\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eac3f5f9-0af5-4c17-8559-f76e2b65086f", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_interval\": 1,\n \"payment_retry_unit\": \"day\",\n \"payment_retry_multiplier\": 1,\n \"payment_retries_limit\": 5,\n \"action\": \"none\",\n \"default\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d4697f9-7dbb-4fa0-82ba-b368385b0e6b", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_interval\": 1,\n \"payment_retry_unit\": \"day\",\n \"payment_retry_multiplier\": 1,\n \"payment_retries_limit\": 5,\n \"action\": \"none\",\n \"default\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "552decbd-9716-41e7-986c-e91e69bcf28d", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_interval\": 1,\n \"payment_retry_unit\": \"day\",\n \"payment_retry_multiplier\": 1,\n \"payment_retries_limit\": 5,\n \"action\": \"none\",\n \"default\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3c258ca-4723-47bb-b1fb-82b0802e40dc", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_interval\": 1,\n \"payment_retry_unit\": \"day\",\n \"payment_retry_multiplier\": 1,\n \"payment_retries_limit\": 5,\n \"action\": \"none\",\n \"default\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ce929ea-0b79-4d41-bf50-2197bcde7b49", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_dunning_rule\",\n \"attributes\": {\n \"payment_retry_type\": \"fixed\",\n \"payment_retry_interval\": 1,\n \"payment_retry_unit\": \"day\",\n \"payment_retry_multiplier\": 1,\n \"payment_retries_limit\": 5,\n \"action\": \"none\",\n \"default\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7a5abb8-6fea-4ae0-8de3-4662c399e344", "name": "Delete dunning rules", "request": { "name": "Delete dunning rules", "description": { "content": "You can delete a dunning rule at any time. If a dunning rule is deleted then Subscriptions reverts to the configuration used if no dunning rule is set; payment is retried once a day for 10 days, in total 11 payments. You can decide what action to take after the Subscriptions has stopped retrying the payments. See [Dunning Rules](/docs/api/subscriptions/dunning-rules).", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d62dce4a-aa5e-423c-b958-254ab1bf6530", "name": "Success. The dunning rule is removed.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid" } ] }, "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": "119638df-3fb9-44fc-9ff2-0fc388091cda", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c5a85cf-485a-410a-b12f-e2da7b3395ff", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "dunning-rules", ":dunning_rule_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a dunning rule set.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "dunning_rule_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Proration Policies", "description": "Proration is the adjustment of charges or credits on a subscriber's account based on the amount of time a service is used. Proration ensures that subscribers are only charged for the actual time they use the service, whether they upgrade, downgrade, start, or cancel their subscription partway through a billing cycle. This means fair billing for your subscribers and provides you with the flexibility to change your subscribers subscriptions at any time. \n\n::: note\n\nSubscriptions use client credentials to enable changes to subscriptions, so if you want your shoppers to have the ability to make changes, you can implement a BFF layer using this approach.\n\n:::\n\nProration occurs for:\n\n- Pricing option upgrades/downgrades: If a subscriber changes their pricing option in the middle of a billing cycle, proration adjusts the charges to reflect the time spent on each pricing option.\n- Service cancellation: If a subscriber cancels a subscription before the end of a billing cycle, they may receive a prorated invoice for the used portion of the subscription.\n- Mid-cycle subscription: If a subscriber starts a subscription in the middle of a billing cycle, they are charged a prorated amount for the remaining days in the billing cycle.\n\nThere are several scenarios when implementing proration policies.\n\n1. You may want one policy for multiple offerings because only some subscriptions need prorating.\n2. You may want a default proration policy for your store.\n3. You may want several policies for different offerings. \n\nIn Subscriptions, charges only prorate by day. As soon as a subscriber changes their subscription, a manual billing run is triggered and an invoice is generated with the new price on the next billing run and the difference in price is prorated over days. \n\nBy default, proration is not enabled for Subscriptions. Once you have attached a proration policy to an offering, proration is enabled automatically.\n\n### End dates when switching pricing options\n\nSubscriptions manages the subscription end date when shoppers switch from one pricing option to another. Whether or not an end date is configured depends on the end behavior of the pricing options you are switching between.\n\n| Current Subscription | New Subscription | Proration Behavior | End date |\n| --- | --- | --- | --- |\n| `close` | `roll` | The subscription switches from a pricing option with a fixed end date to a rolling pricing option so no end date is set after proration. | No end date is configured. |\n| `roll` | `close` | The subscription switches to a fixed pricing option, and the end date is configured based on the duration of the pricing option. | An end date is configured. |\n| `close` | `close` | The remaining time on the current pricing option is not carried over to the new pricing option. For example, if your current pricing option has 3 months remaining and you switch to a new pricing option that has a fixed length of 6 months, the new end date is calculated as 6 months from the day you switch pricing options, effectively resetting the subscription length to the new pricing option. | New end date calculated from the day you switched pricing option. |\n", "item": [ { "id": "33cf4adc-5bee-4039-b563-7d071eb8ccc2", "name": "Create a Proration Policy", "request": { "name": "Create a Proration Policy", "description": { "content": "In Subscriptions, you configure proration by creating a proration policy and attaching it to an offering. Once you have [attached](/docs/api/subscriptions/update-offering) the policy, the proration policy applies to all subscriptions that use the offering.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "proration-policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"name\": \"Main Policy\",\n \"rounding\": \"up\",\n \"external_ref\": \"abc123\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7120776a-2387-453c-a366-151951ede69b", "name": "Success. The proration policy is created.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"name\": \"Main Policy\",\n \"rounding\": \"up\",\n \"external_ref\": \"abc123\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"name\": \"Main Policy\",\n \"rounding\": \"up\",\n \"external_ref\": \"abc123\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10ba0cdc-7540-44a1-a833-5a8a6435a483", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"name\": \"Main Policy\",\n \"rounding\": \"up\",\n \"external_ref\": \"abc123\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85805f45-0860-4fed-af16-98dd9b8048f6", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"name\": \"Main Policy\",\n \"rounding\": \"up\",\n \"external_ref\": \"abc123\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "635d6f99-8b35-4e39-97c1-3e0d56a77a94", "name": "List proration policies", "request": { "name": "List proration policies", "description": { "content": "Retrieves a list of all proration policies.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "proration-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "635d99f7-cf34-4abf-b7e7-c4ce606ae6d4", "name": "Success. A list of proration policies is returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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 \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"name\": \"Main Policy\",\n \"rounding\": \"up\",\n \"external_ref\": \"abc123\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"name\": \"Main Policy\",\n \"rounding\": \"up\",\n \"external_ref\": \"abc123\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n ],\n \"links\": {\n \"key_0\": \"http://example.com/articles/1/comments\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fcff839-b724-4463-852e-30768fe6b3d4", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5626bc5b-4993-452b-b314-829de4b7a04f", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[offset]", "value": "10" }, { "disabled": false, "description": { "content": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.", "type": "text/plain" }, "key": "page[limit]", "value": "100" } ], "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37e343a3-5e6b-4468-9fca-b1b1b8e67618", "name": "Get proration policy", "request": { "name": "Get proration policy", "description": {}, "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e2bb49ed-273c-4c75-ab33-d8adfdad903e", "name": "Success. The proration policy details are returned.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid" } ] }, "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 \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"name\": \"Main Policy\",\n \"rounding\": \"up\",\n \"external_ref\": \"abc123\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d03cb687-b74e-421c-9198-48910c07c6fd", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51dca79b-734a-4d28-8f24-58876a240f1a", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid" } ] }, "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 \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2305a1d5-cbfe-49b3-80a3-897466323a02", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "18b36597-036b-4cc3-b448-5443453b80ba", "name": "Update proration policy", "request": { "name": "Update proration policy", "description": { "content": "You can update a proration policy at any time. For any subscriptions that are using the updated proration policy, the changes are also applied. Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the proration policy is not updated.\n\nWhen updating proration policies:\n\n- You can change the name of an existing policy.\n- You can update `rounding`.\n- You can update `external_ref` as long as `external_ref` is still unique in your store.\n- You can remove `external_ref` as this attribute is optional.\n- You cannot remove any required attributes, such as `name` or `rounding`.\n", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Main Policy\",\n \"rounding\": \"up\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "eb080c05-a67c-4423-a521-f976b80a438e", "name": "Success. The proration policy details are updated.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Main Policy\",\n \"rounding\": \"up\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"name\": \"Main Policy\",\n \"rounding\": \"up\",\n \"external_ref\": \"abc123\"\n },\n \"meta\": {\n \"owner\": \"store\",\n \"timestamps\": {\n \"created_at\": \"2017-01-10T11:41:19.244842Z\",\n \"updated_at\": \"2017-01-10T11:41:19.244842Z\"\n }\n },\n \"id\": \"11111111-2222-3333-4444-555555555555\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78eab44e-41df-4721-86bd-95ec0664a804", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Main Policy\",\n \"rounding\": \"up\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62a66085-8c3a-41d6-82ae-1a3cb56d5f07", "name": "Forbidden. The operation is forbidden on this entity.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Main Policy\",\n \"rounding\": \"up\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Permission denied\",\n \"status\": \"404\",\n \"detail\": \"Permission denied: plan tenancy mismatch\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e89cc95-1134-46c2-8bdd-a2f6fd01b40e", "name": "Not found. The requested entity does not exist.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Main Policy\",\n \"rounding\": \"up\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Not Found\",\n \"status\": \"404\",\n \"detail\": \"No plan found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0785a074-7fa2-4c72-8583-6f2a2da973f4", "name": "Write conflict. Unable to perform the operation at this time.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid" } ] }, "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 \"data\": {\n \"id\": \"11111111-2222-3333-4444-555555555555\",\n \"type\": \"subscription_proration_policy\",\n \"attributes\": {\n \"external_ref\": \"abc123\",\n \"name\": \"Main Policy\",\n \"rounding\": \"up\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Write Conflict\",\n \"status\": \"409\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "01af09ab-732b-449d-a6bf-c6dec12b0315", "name": "Delete proration policy", "request": { "name": "Delete proration policy", "description": { "content": "A proration policy cannot be deleted if it is being used by any subscriptions. This means you must detach a proration policy that you want to delete from any offerings using that policy before deleting the policy. See [Remove a proration policy from an offering](/docs/api/subscriptions/update-offering).", "type": "text/plain" }, "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid", "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d9702f61-3398-49e1-955c-c9b8129096a2", "name": "Success. The proration policy details are removed.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid" } ] }, "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": "085dc8f8-7057-4ccd-8f63-b832c2a0656f", "name": "Bad request. The request failed validation.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid" } ] }, "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Validation Error\",\n \"status\": \"400\",\n \"detail\": \"data.attributes.name: \\\"name\\\" is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d269d456-fb51-4315-8348-e63864fccdab", "name": "Internal server error. There was a system failure in the platform.", "originalRequest": { "url": { "path": [ "v2", "subscriptions", "proration-policies", ":proration_policy_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a proration policy.", "type": "text/plain" }, "type": "any", "value": "11111111-2222-3333-4444-555555555555", "key": "proration_policy_uuid" } ] }, "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": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"title\": \"Internal Server Error\",\n \"status\": \"500\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Observable Events", "description": "You can integrate Subscriptions with external systems like enterprise resource planning, fulfilment and other systems. For example, when a subscriber updates their address, the Customer Relationship Management system is updated with the change. \n\nEvents are actions that occur in Subscriptions, such as a subscriber changing their address or a subscription changing from active to inactive. You can create custom functions that perform additional processing outside of Subscriptions, and create integrations so that when an event occurs in your store, the custom function is run.\n\nEvents are processed concurrently. This means that events may not be delivered in the order they are created. For example, if a subscription is updated multiple times, the events may not be delivered in the same sequence they were updated. Events operate on an \"at least once\" delivery policy. We aim to deliver messages within 30 minutes or less. Ensure that you design your receiving code accordingly.\n\nFor more information about integrating Subscriptions, see [**Integrations (Event Subscriptions/Notifications)**](/docs/api/integrations/integrations-event-subscriptions-notifications#integration-types).\n\n| Resource | Action | Observable Key | Availability |\n| --- | --- | --- | --- |\n| Offering |
  • Created
  • Updated
  • Deleted
|
  • `subscription-offering.created`
  • `subscription-offering.updated`
  • `subscription-offering.deleted`
| Store |\n| Subscription |
  • Created
  • Create-failed
  • Paused
  • Canceled
  • Pending-cancel
  • Pending-pause
  • Resumed
  • Closed
|
  • `subscription.created`
  • `subscription.create-failed`
  • `subscription.canceled`
  • `subscription.paused`
  • `subscription.pending_cancel`
  • `subscription.pending_pause`
  • `subscription.resumed`
  • `subscription.closed`
| Store |\n| Job |
  • Created
  • Updated
  • Deleted
|
  • `subscription-job.created`
  • `subscription-job.updated`
  • `subscription-job.deleted`
| Store |\n| Invoices |
  • Created
  • Deleted
|
  • `subscription-invoice.created`
  • `subscription-invoice.deleted`
| Store |\n| Schedule |
  • Created
  • Updated
  • Deleted
|
  • `subscription-schedule.created`
  • `subscription-schedule.updated`
  • `subscription-schedule.deleted`
| Store |\n| Subscriber |
  • Created
  • Updated
  • Deleted
|
  • `subscription-subscriber.created`
  • `subscription-subscriber.updated`
  • `subscription-subscriber.deleted`
| Store |\n", "item": [] } ], "variable": [ { "key": "baseUrl", "value": "https://useast.api.elasticpath.com", "type": "string" }, { "key": "baseUrl", "value": "https://euwest.api.elasticpath.com", "type": "string" }, { "key": "baseUrl", "value": "https://euwest.api.elasticpath.com/v2", "type": "string" }, { "key": "baseUrl", "value": "https://api.moltin.com", "type": "string" } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] } }