{ "item": [ { "name": "products", "description": "", "item": [ { "name": "add-ons", "description": "", "item": [ { "id": "4a769b59-d8f3-45f9-aa03-f7eed18de852", "name": "Get a list of product item(article) numbers, passed in the query, with their add-ons", "request": { "name": "Get a list of product item(article) numbers, passed in the query, with their add-ons", "description": { "content": "This endpoint takes a comma (,) separated list of product item(article) numbers that are passed in the query and returns a list of product item(article) numbers, passed in the query, with their add-ons. The add-ons contain information on their relation to the input product, sorted by relevancy. If the products do not have any add-on products then it returns an empty array\n", "type": "text/plain" }, "url": { "path": [ "products", "add-ons" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma (`,`) separated list of product item(article) numbers", "type": "text/plain" }, "key": "products", "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": "Maximum number of items to return per main product type", "type": "text/plain" }, "key": "limitPerMainProductType", "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": "029c16ed-bae6-431a-b74a-e37ac1ebdee4", "name": "Returns a list of ProductWithAddons objects or an empty array, if no add-on products are found in the IKEA Knowledge graph.", "originalRequest": { "url": { "path": [ "products", "add-ons" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma (`,`) separated list of product item(article) numbers", "type": "text/plain" }, "key": "products", "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": "Maximum number of items to return per main product type", "type": "text/plain" }, "key": "limitPerMainProductType", "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\": \"86314971\",\n \"productAddons\": [\n {\n \"itemType\": \"ART\",\n \"itemNo\": \"00000000\",\n \"itemName\": \"\",\n \"retailUnits\": [\n \"\",\n \"\"\n ],\n \"mainProductType\": {\n \"number\": \"\",\n \"name\": \"\"\n },\n \"relevanceScore\": \"\",\n \"relations\": [\n {\n \"iri\": \"\",\n \"name\": \"\"\n },\n {\n \"iri\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"itemType\": \"SPR\",\n \"itemNo\": \"46270946\",\n \"itemName\": \"\",\n \"retailUnits\": [\n \"\",\n \"\"\n ],\n \"mainProductType\": {\n \"number\": \"\",\n \"name\": \"\"\n },\n \"relevanceScore\": \"\",\n \"relations\": [\n {\n \"iri\": \"\",\n \"name\": \"\"\n },\n {\n \"iri\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"itemNo\": \"61616161\",\n \"productAddons\": [\n {\n \"itemType\": \"SPR\",\n \"itemNo\": \"31231231\",\n \"itemName\": \"\",\n \"retailUnits\": [\n \"\",\n \"\"\n ],\n \"mainProductType\": {\n \"number\": \"\",\n \"name\": \"\"\n },\n \"relevanceScore\": \"\",\n \"relations\": [\n {\n \"iri\": \"\",\n \"name\": \"\"\n },\n {\n \"iri\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"itemType\": \"ART\",\n \"itemNo\": \"74918749\",\n \"itemName\": \"\",\n \"retailUnits\": [\n \"\",\n \"\"\n ],\n \"mainProductType\": {\n \"number\": \"\",\n \"name\": \"\"\n },\n \"relevanceScore\": \"\",\n \"relations\": [\n {\n \"iri\": \"\",\n \"name\": \"\"\n },\n {\n \"iri\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06d376c1-9c54-4544-88f0-72e925f787d6", "name": "Bad request", "originalRequest": { "url": { "path": [ "products", "add-ons" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma (`,`) separated list of product item(article) numbers", "type": "text/plain" }, "key": "products", "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": "Maximum number of items to return per main product type", "type": "text/plain" }, "key": "limitPerMainProductType", "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": "53f4bb80-b8e5-4c4f-8e94-046aaffbd4c7", "name": "API key is missing or invalid", "originalRequest": { "url": { "path": [ "products", "add-ons" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma (`,`) separated list of product item(article) numbers", "type": "text/plain" }, "key": "products", "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": "Maximum number of items to return per main product type", "type": "text/plain" }, "key": "limitPerMainProductType", "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": "3d5fdee4-799c-4ae0-bfbd-94dd214081b3", "name": "A request to the server cannot be processed", "originalRequest": { "url": { "path": [ "products", "add-ons" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma (`,`) separated list of product item(article) numbers", "type": "text/plain" }, "key": "products", "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": "Maximum number of items to return per main product type", "type": "text/plain" }, "key": "limitPerMainProductType", "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": "{itemNo}", "description": "", "item": [ { "name": "add-ons", "description": "", "item": [ { "id": "c633b499-d79e-4896-bf34-2a64d62086e0", "name": "Get a list of add-on products by item(article) number", "request": { "name": "Get a list of add-on products by item(article) number", "description": { "content": "This endpoint takes a product item(article) number and returns a list of add-on products, with information on their relation to the input product, ordered by relevancy. If the product does not have any add-on products it returns an empty array", "type": "text/plain" }, "url": { "path": [ "products", ":itemNo", "add-ons" ], "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": "Maximum number of items to return per main product type", "type": "text/plain" }, "key": "limitPerMainProductType", "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": "92387749", "key": "itemNo", "disabled": false, "description": { "content": "(Required) The 8-digit item number, also known as the article number, of a product", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e5322840-6544-4323-82b3-f766d698e984", "name": "Returns a list of ProductAddon objects, sorted by relevanceScore, or an empty array, if no add-on products are defined in the IKEA knowledge graph", "originalRequest": { "url": { "path": [ "products", ":itemNo", "add-ons" ], "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": "Maximum number of items to return per main product type", "type": "text/plain" }, "key": "limitPerMainProductType", "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\": \"SPR\",\n \"itemNo\": \"44444444\",\n \"itemName\": \"\",\n \"retailUnits\": [\n \"\",\n \"\"\n ],\n \"mainProductType\": {\n \"number\": \"\",\n \"name\": \"\"\n },\n \"relevanceScore\": \"\",\n \"relations\": [\n {\n \"iri\": \"\",\n \"name\": \"\"\n },\n {\n \"iri\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"itemType\": \"ART\",\n \"itemNo\": \"00030003\",\n \"itemName\": \"\",\n \"retailUnits\": [\n \"\",\n \"\"\n ],\n \"mainProductType\": {\n \"number\": \"\",\n \"name\": \"\"\n },\n \"relevanceScore\": \"\",\n \"relations\": [\n {\n \"iri\": \"\",\n \"name\": \"\"\n },\n {\n \"iri\": \"\",\n \"name\": \"\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "971eb8f7-eca3-4096-9f3d-23b0e2fef980", "name": "Bad request", "originalRequest": { "url": { "path": [ "products", ":itemNo", "add-ons" ], "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": "Maximum number of items to return per main product type", "type": "text/plain" }, "key": "limitPerMainProductType", "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": "521ec3f2-5229-41c5-b923-bb344dd939c7", "name": "API key is missing or invalid", "originalRequest": { "url": { "path": [ "products", ":itemNo", "add-ons" ], "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": "Maximum number of items to return per main product type", "type": "text/plain" }, "key": "limitPerMainProductType", "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": "370ab115-0e18-4b08-8563-19ef9b0c8f71", "name": "A request to the server cannot be processed", "originalRequest": { "url": { "path": [ "products", ":itemNo", "add-ons" ], "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": "Maximum number of items to return per main product type", "type": "text/plain" }, "key": "limitPerMainProductType", "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": "215dfc28a2384bed954973e8cf5374d8" }, { "key": "baseUrl", "value": "https://knowledge.api.inter.ikea.net/cbr/rosd/ikg/api/product-add-ons/v1" } ], "info": { "_postman_id": "8427bf1e-31f4-47ad-8f7d-89e05a81ea89", "name": "Product Add-ons", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "## What is it?\n\nThe Product Add-ons API provides a list of products to recommend, with basic product information\nand additional relevant attributes, from IKEA Knowledge Graph\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" } } }