{ "item": [ { "name": "products", "description": "", "item": [ { "name": "{itemNo}", "description": "", "item": [ { "id": "ebb9dd2f-e9e5-4673-adb3-7ddc4861c9f9", "name": "Get Graph Product by Item Number", "request": { "name": "Get Graph Product by Item Number", "description": { "content": "This endpoint takes an `itemNo` of a Product contained within the Knowledge Graph and returns a `BackOffToHeroProduct` which contains additional properties.\nIf the item is neither Back-Off nor Hero an empty object will be returned\n", "type": "text/plain" }, "url": { "path": [ "products", ":itemNo" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) seperated list of back-off product or hero product fields that we want the response to contain", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "itemNo", "disabled": false, "description": { "content": "(Required) The `itemNo` or the the IKEA Product in the Graph", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0e28d737-959d-46ad-83f1-0c633c223107", "name": "Returns a `BackOffToHeroProduct` Object, or an empty object if it is neither a back-off nor a hero product", "originalRequest": { "url": { "path": [ "products", ":itemNo" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) seperated list of back-off product or hero product fields that we want the response to contain", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"itemType\": \"SPR\",\n \"itemNo\": \"\",\n \"itemName\": \"\",\n \"retailUnits\": [\n \"\",\n \"\"\n ],\n \"strategicPricingRole\": \"back-off\",\n \"protectsHero\": [\n {\n \"itemNo\": \"63636363\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"27170558\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"protectedBy\": [\n {\n \"itemNo\": \"40040040\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"07802450\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"upsellArguments\": [\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n },\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d83041cb-40b4-4d52-a788-fa892954c086", "name": "Bad request", "originalRequest": { "url": { "path": [ "products", ":itemNo" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) seperated list of back-off product or hero product fields that we want the response to contain", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e050672-6535-414b-8a94-61826791cb92", "name": "API key is missing or invalid", "originalRequest": { "url": { "path": [ "products", ":itemNo" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) seperated list of back-off product or hero product fields that we want the response to contain", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5322f6c-3dff-4d91-9c09-22c6ff4da9cd", "name": "Resource not found", "originalRequest": { "url": { "path": [ "products", ":itemNo" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) seperated list of back-off product or hero product fields that we want the response to contain", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "998afcd1-9071-4cce-a7a4-769c33be1547", "name": "A request to the server cannot be processed", "originalRequest": { "url": { "path": [ "products", ":itemNo" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) seperated list of back-off product or hero product fields that we want the response to contain", "type": "text/plain" }, "key": "fields", "value": "" }, { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "heroes", "description": "", "item": [ { "id": "58bc3234-79bf-4e74-a231-702ca4d6c455", "name": "Get All Graph Hero Products", "request": { "name": "Get All Graph Hero Products", "description": { "content": "Returns an array that contains all Hero products from the Graph", "type": "text/plain" }, "url": { "path": [ "products", "heroes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cb5d24dd-8427-452d-9ae6-8abd0d8dd7c3", "name": "An array of Products that are Hero Products with Strategic Pricing, Hero and Back-Off properties", "originalRequest": { "url": { "path": [ "products", "heroes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"itemType\": \"ART\",\n \"itemNo\": \"\",\n \"itemName\": \"\",\n \"retailUnits\": [\n \"\",\n \"\"\n ],\n \"strategicPricingRole\": \"back-off\",\n \"protectsHero\": [\n {\n \"itemNo\": \"28002812\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"51265126\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"protectedBy\": [\n {\n \"itemNo\": \"35206393\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"94125188\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"upsellArguments\": [\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n },\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n }\n ]\n },\n {\n \"itemType\": \"SPR\",\n \"itemNo\": \"\",\n \"itemName\": \"\",\n \"retailUnits\": [\n \"\",\n \"\"\n ],\n \"strategicPricingRole\": \"back-off\",\n \"protectsHero\": [\n {\n \"itemNo\": \"04040404\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"37042037\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"protectedBy\": [\n {\n \"itemNo\": \"67552190\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"90059005\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"upsellArguments\": [\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n },\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a66dcbfa-3d55-4de1-888a-9fde4a636e6c", "name": "Bad request", "originalRequest": { "url": { "path": [ "products", "heroes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a13ca0c3-d0cf-425b-855f-75bc1588551f", "name": "API key is missing or invalid", "originalRequest": { "url": { "path": [ "products", "heroes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4312c405-4672-4737-a9d5-ec3aa16ec329", "name": "A request to the server cannot be processed", "originalRequest": { "url": { "path": [ "products", "heroes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "item-numbers", "description": "", "item": [ { "id": "e8406760-b035-4851-9d86-df4b1cbcef8d", "name": "Get All Hero Product `itemNo`", "request": { "name": "Get All Hero Product `itemNo`", "description": { "content": "Returns an array of all Graph Hero Product `itemNo` property", "type": "text/plain" }, "url": { "path": [ "products", "heroes", "item-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d3357bd6-dfbc-4f1d-b734-47a3da37831b", "name": "An array of string values that are the `itemNo` of all Graph Hero Products", "originalRequest": { "url": { "path": [ "products", "heroes", "item-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"\",\n \"\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a15a52d3-4f0d-4927-8885-3aee5e2319bc", "name": "Bad request", "originalRequest": { "url": { "path": [ "products", "heroes", "item-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0bc8478-1d18-4bc4-8c45-73afeec6f480", "name": "API key is missing or invalid", "originalRequest": { "url": { "path": [ "products", "heroes", "item-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76d0ccfd-84b6-4009-a5ce-bb339b9c7276", "name": "A request to the server cannot be processed", "originalRequest": { "url": { "path": [ "products", "heroes", "item-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "back-offs", "description": "", "item": [ { "id": "c042a7d8-e01b-4db0-aad5-e7ffca833550", "name": "Get All Graph Back-Off Products", "request": { "name": "Get All Graph Back-Off Products", "description": { "content": "Returns an array that contains all Back-Off products from the Graph", "type": "text/plain" }, "url": { "path": [ "products", "back-offs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2adccebc-6f1b-40b6-89e7-ff9db7b76eec", "name": "An array of Products that are Back-Off Products with Strategic Pricing, Hero and Back-Off properties", "originalRequest": { "url": { "path": [ "products", "back-offs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"itemType\": \"ART\",\n \"itemNo\": \"\",\n \"itemName\": \"\",\n \"retailUnits\": [\n \"\",\n \"\"\n ],\n \"strategicPricingRole\": \"back-off\",\n \"protectsHero\": [\n {\n \"itemNo\": \"28002812\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"51265126\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"protectedBy\": [\n {\n \"itemNo\": \"35206393\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"94125188\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"upsellArguments\": [\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n },\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n }\n ]\n },\n {\n \"itemType\": \"SPR\",\n \"itemNo\": \"\",\n \"itemName\": \"\",\n \"retailUnits\": [\n \"\",\n \"\"\n ],\n \"strategicPricingRole\": \"back-off\",\n \"protectsHero\": [\n {\n \"itemNo\": \"04040404\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"37042037\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"protectedBy\": [\n {\n \"itemNo\": \"67552190\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"90059005\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"upsellArguments\": [\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n },\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "422be44f-718e-436a-8c88-a75e3d76d47f", "name": "Bad request", "originalRequest": { "url": { "path": [ "products", "back-offs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3709b017-28ab-458e-a035-a44e5e2d186a", "name": "API key is missing or invalid", "originalRequest": { "url": { "path": [ "products", "back-offs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac75ab94-2516-47b8-9d66-08bd7dceba86", "name": "A request to the server cannot be processed", "originalRequest": { "url": { "path": [ "products", "back-offs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "item-numbers", "description": "", "item": [ { "id": "839f5df2-cbd9-4b39-a928-489a188fd4c6", "name": "Get All Back-Off Product `itemNo`", "request": { "name": "Get All Back-Off Product `itemNo`", "description": { "content": "Returns an array of all Graph Back-Off Product `itemNo` property", "type": "text/plain" }, "url": { "path": [ "products", "back-offs", "item-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "289946f3-b573-4178-a7d2-c047f864d5e0", "name": "An array of string values that are the `itemNo` of all Graph Back-Off Products", "originalRequest": { "url": { "path": [ "products", "back-offs", "item-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"\",\n \"\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "107c807f-2c7c-45e9-8e3e-bd7a7187525a", "name": "Bad request", "originalRequest": { "url": { "path": [ "products", "back-offs", "item-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ef4816c-2780-48c4-b658-65c3fc49613d", "name": "API key is missing or invalid", "originalRequest": { "url": { "path": [ "products", "back-offs", "item-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0af78aa1-0300-483a-957c-e4f764522d0c", "name": "A request to the server cannot be processed", "originalRequest": { "url": { "path": [ "products", "back-offs", "item-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "2414d878-d8fb-4b67-a659-56e21515a228", "name": "Get a list of product item numbers, passed in the query, with their Back-Off/Hero properties", "request": { "name": "Get a list of product item numbers, passed in the query, with their Back-Off/Hero properties", "description": { "content": "This endpoint takes a comma (,) separated list of product item numbers that are passed in the query as input and returns the same list of item numbers with Back-Off/Hero properties as `result`. If the item is neither a backoff or a hero the `result` will be an empty object\n", "type": "text/plain" }, "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma (`,`) separated list of product item numbers", "type": "text/plain" }, "key": "itemNumbers", "value": "79633766" }, { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "be99dcd6-d0c9-4f35-91ed-f7c438ca0fa6", "name": "Returns a list of product item numbers with back-off/hero properties as `result`, or empty `result` if any of the products is neither a Back-Off nor a Hero product", "originalRequest": { "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma (`,`) separated list of product item numbers", "type": "text/plain" }, "key": "itemNumbers", "value": "79633766" }, { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"itemNo\": \"20082020\",\n \"result\": {\n \"itemType\": \"SPR\",\n \"itemNo\": \"\",\n \"itemName\": \"\",\n \"retailUnits\": [\n \"\",\n \"\"\n ],\n \"strategicPricingRole\": \"back-off\",\n \"protectsHero\": [\n {\n \"itemNo\": \"93569140\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"96720147\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"protectedBy\": [\n {\n \"itemNo\": \"22222222\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"11111111\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"upsellArguments\": [\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n },\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n }\n ]\n }\n },\n {\n \"itemNo\": \"02320880\",\n \"result\": {\n \"itemType\": \"ART\",\n \"itemNo\": \"\",\n \"itemName\": \"\",\n \"retailUnits\": [\n \"\",\n \"\"\n ],\n \"strategicPricingRole\": \"hero\",\n \"protectsHero\": [\n {\n \"itemNo\": \"66666666\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"17850161\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"protectedBy\": [\n {\n \"itemNo\": \"44444444\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n },\n {\n \"itemNo\": \"72097135\",\n \"retailUnits\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"upsellArguments\": [\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n },\n {\n \"shortText\": \"\",\n \"longText\": \"\"\n }\n ]\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84f39760-4259-46a1-955b-40a8a16dae6e", "name": "Bad request", "originalRequest": { "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma (`,`) separated list of product item numbers", "type": "text/plain" }, "key": "itemNumbers", "value": "79633766" }, { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1527349c-b380-4202-a742-c8ef13061399", "name": "API key is missing or invalid", "originalRequest": { "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma (`,`) separated list of product item numbers", "type": "text/plain" }, "key": "itemNumbers", "value": "79633766" }, { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbed89d9-6b46-44c2-a006-4427e307a45d", "name": "A request to the server cannot be processed", "originalRequest": { "url": { "path": [ "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma (`,`) separated list of product item numbers", "type": "text/plain" }, "key": "itemNumbers", "value": "79633766" }, { "disabled": false, "description": { "content": "A comma (`,`) separated list of retail units. If no retail units are provided, the retail unit associated with the queried product is used as the filter. If retail units are provided, the resulting output is filtered by the common retail units between the product's retail units and those passed via the retail units query parameter.", "type": "text/plain" }, "key": "retailUnits", "value": "," }, { "disabled": false, "description": { "content": "Include products covering a range of 56 days before the sale start date to 360 days after the sale end date.", "type": "text/plain" }, "key": "enableMarketSalesDate", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Subscription-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "Subscription-Key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] }, "event": [], "variable": [ { "key": "apiKey", "value": "541adb6b288b42f1b981f2da8a5571f1" }, { "key": "baseUrl", "value": "https://knowledge.api.inter.ikea.net/cbr/rosd/ikg/api/back-off-to-hero/v2" } ], "info": { "_postman_id": "e781dbc0-86fa-4337-a68d-a1aed58b643c", "name": "Back-Off to Hero", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "## What is it?\n\nThe Back-Off to Hero API provides Product information to any IKEA API consumer\nwith additional Back-Off or Hero attributes for IKEA Products contained within\nthe IKEA Knowledge Graph\n\n## How to get access?\n\nTo request access to the API and Documentation about it's design send an email to [ikea.knowledge.graph@inter.ikea.com](mailto:ikea.knowledge.graph@inter.ikea.com) with any questions\n\nWe also accept requests for new features\n\n
\n\n\nContact Support:\n Email: ikea.knowledge.graph@inter.ikea.com", "type": "text/plain" } } }